Skip to content

Commit 5b1ed40

Browse files
committed
UPDATED: Update libMultiMarkdown.h comments
1 parent db7df76 commit 5b1ed40

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

src/libMultiMarkdown.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -150,15 +150,15 @@ void custom_seed_rand(void);
150150

151151
enum output_format {
152152
FORMAT_HTML, //!< Plain HTML
153-
FORMAT_AST,
154-
FORMAT_EPUB,
155-
FORMAT_HASH,
156-
FORMAT_ITMZ,
153+
FORMAT_AST, //!< Display the AST for informational/debugging purposes
154+
FORMAT_EPUB, //!< EPUB v3
155+
FORMAT_HASH, //!< Display the AST with hash values for informational/debugging purposes
156+
FORMAT_ITMZ, //!< iThoughts Mind Mapping document
157157
FORMAT_LATEX, //!< LaTeX to generate PDF
158158
FORMAT_MMD, //!< Raw MultiMarkdown source text
159-
FORMAT_OPML,
160-
FORMAT_TEXTBUNDLE,
161-
FORMAT_TEXTPACK,
159+
FORMAT_OPML, //!< Outline Processor Markup Language for outliners or mind-mapping programs
160+
FORMAT_TEXTBUNDLE, //!< TextBundle is a package file format for macOS/iOS
161+
FORMAT_TEXTPACK, //!< Compressed variant of the TextBundle file format
162162

163163
FORMAT_DOCX,
164164
FORMAT_BEAMER,
@@ -424,9 +424,9 @@ enum node_types {
424424
TOKEN_PAIR_QUOTE_DOUBLE,
425425
TOKEN_PAIR_QUOTE_SINGLE,
426426
TOKEN_PAIR_STAR,
427-
TOKEN_PAIR_STAR_USED, // Must immediately follow TOKEN_PAIR_STAR
427+
TOKEN_PAIR_STAR_USED, //!< Must immediately follow TOKEN_PAIR_STAR
428428
TOKEN_PAIR_UL,
429-
TOKEN_PAIR_UL_USED, // Must immediately follow TOKEN_PAIR_UL
429+
TOKEN_PAIR_UL_USED, //!< Must immediately follow TOKEN_PAIR_UL
430430
TOKEN_SPECIAL_CHARACTER,
431431

432432
TOKEN_PAIR_EMPH,

0 commit comments

Comments
 (0)