data: Update documentation to reflect exactly which fields are processed with Markdown

Author: slusarz

data/doveadm.js

@@ -30,7 +30,7 @@ export const doveadm = {
 				// The argument type
 				type: doveadm_arg_types.BOOL,
 
-				// Description of the parameter
+				// Description of the parameter. Rendered w/Markdown.
 				text: `Do a reverse move?`,
 			},
 			query: doveadm_args_query,
@@ -39,14 +39,14 @@ export const doveadm = {
 		// Change Documentation
 		// added: {
 		//     // KEY = update identifier (see data/updates.js)
-		//     // VALUE = Text to display
+		//     // VALUE = Text to display. Rendered w/Markdown.
 		//     'update_identifier': `Update description`
 		// },
 		// changed: {},
 		// deprecated: {},
 		// removed: {},
 
-		// Fields/Values returned. Values are processed w/Markdown
+		// Fields/Values returned. Values are rendered w/Markdown.
 		// fields: {},
 
 		// What doveadm flags does this command support (bit field)
@@ -62,7 +62,7 @@ export const doveadm = {
 		// Tag name(s). String or array.
 		// tags: 'foo', // or [ 'foo1', 'foo2', ... ]
 
-		// Summary of command. Processed w/Markdown
+		// Summary of command. Rendered w/Markdown.
 		text: `
 Move mails between primary and alternative mailbox storage locations.
 

data/event_categories.js

@@ -8,7 +8,7 @@ export const categories = {
 	auth: {
 		// Category type
 		category: 'root',
-		// Category description (rendered with Markdown)
+		// Category description. Rendered w/Markdown.
 		description: `Authentication (server mainly)`
 	},
 

data/event_reasons.js

@@ -3,8 +3,12 @@
  * Keys are reasons, Values are object. */
 
 export const reasons = {
+
+	// KEY: Event reason
 	'storage:autoexpunge': {
+		// Category type
 		category: 'storage',
+		// Category description. Rendered w/Markdown.
 		description: `Mails are being autoexpunged`
 	},
 

data/events.js

@@ -52,12 +52,12 @@ export const events = {
 				// removed: {
 				//     <tag>: `Description of change (or 'false')`,
 				// },
-				// Field Description
+				// Field Description. Rendered w/Markdown
 				// text: ``,
 			// }
 		},
 
-		// Summary of event. Processed w/Markdown.
+		// Summary of event. Rendered w/Markdown.
 		text: `Emitted when a message is expunged from a mailbox.`
 	},
 

data/lua.js

@@ -2,14 +2,22 @@
 
 export const lua_functions = {
 
+	// KEY: Lua function signature
 	'dovecot.i_debug(text)': {
+		// List of function arguments
 		params: {
+			// Argument label (should match function signature example)
 			text: {
+				// Argument type
 				type: 'string',
+				// Argument description. Rendered w/Markdown.
 				text: `Message to log.`
 			},
 		},
+		// List of tags to associate with this function (used for display
+		// separation)
 		tags: [ 'base '],
+		// Function description. Rendered w/Markdown.
 		text: `Log debug level message.`
 	},
 

data/settings.js

@@ -11,7 +11,7 @@ export const settings = {
 		// Change Documentation
 		// KEY = update identifier (see data/updates.js)
 		// VALUE = Text to display. "false" means only the version
-		// and change type is displayed
+		// and change type is displayed. Rendered w/Markdown.
 		// added: {
 		//     'update_identifier': `Update description`
 		// },
@@ -20,10 +20,10 @@ export const settings = {
 		// removed: {},
 
 		// Default value of the setting. If not set, is displayed as "None".
-		// This can be markdown.
+		// Rendered w/Markdown.
 		// default: '',
 
-		// A list of "See Also" links to display. This can be markdown.
+		// A list of "See Also" links to display. Rendered w/Markdown.
 		// Text entries are processed as inter-settings links.
 		// seealso: [],
 
@@ -41,7 +41,7 @@ export const settings = {
 		// in a separate section on the All Settings page.
 		advanced: true,
 
-		// Setting description. Markdown can be used.
+		// Setting description. Rendered w/Markdown.
 		text: `
 If the destination for proxying matches any of the IP addresses listed
 here, proxying is not performed when \`proxy_maybe=yes\` is returned.