89f9bcf4c48af7a8c24bac5c517c7b1adff667ed kent Thu Mar 28 22:48:02 2013 -0700 Improving comment diff --git src/inc/meta.h src/inc/meta.h index 2861bd7..fdd7faf 100644 --- src/inc/meta.h +++ src/inc/meta.h @@ -25,31 +25,31 @@ struct metaTagVal *metaTagValNew(char *tag, char *val); /* Create new meta tag/val */ int metaTagValCmp(const void *va, const void *vb); /* Compare to sort based on tag name . */ struct meta /* A node in the metadata tree */ { struct meta *next; /* Pointer to next younger sibling. */ struct meta *children; /* Pointer to eldest child. */ struct meta *parent; /* Pointer to parent. */ char *name; /* Same as val of meta tag. Not allocated here. */ struct metaTagVal *tagList; /* All tags, including the "meta" one. */ - int indent; /* Indentation level. */ + int indent; /* Indentation level - generally only set if read from file. */ }; struct meta *metaLoadAll(char *fileName, char *keyTag, char *parentTag, boolean ignoreOtherStanzas, boolean ignoreIndent); /* Loads in all ra stanzas from file and turns them into a list of meta, some of which * may have children. The keyTag parameter is optional. If non-null it should be set to * the tag name that starts a stanza. If null, the first tag of the first stanza will be used. * The parentTag if non-NULL will be a tag name used to define the parent of a stanza. * The ignoreOtherStanzas flag if set will ignore stanzas that start with other tags. * If not set the routine will abort on such stanzas. The ignoreIndent if set will * use the parentTag (which must be set) to define the hierarchy. Otherwise the program * will look at the indentation, and if there is a parentTag complain about any * disagreements between indentation and parentTag. */ void metaWriteAll(struct meta *metaList, char *fileName, int indent, boolean withParent);