dogen

By Bowuigi

Simple and easy way of generating documentation from comments, it is language agnostic, great for small proyects

Licensed under the Zlib license

Dictionaries

acc_prefix

Accepted prefixes for dogen commands like dict, function, etc.

Fields:

• character \: 'backslash' character, to make switching from Doxygen easier

• character @: 'at' character is supported, might be useful if you already have a codebase using Javadoc, Doxygen, etc.

• character !: 'exclamation sign' character, because why not, it looks cool

Functions

dict

For struct/dictionary/hash table/whatever documentation, the name for it on the output can be changed on the dogenfile

Parameters:

• string name: For structs, the type name, for everything else, the name of the global instance of the data structure

• string description: Description of what that type/instance is for

Return values:

1. string: Nicely formatted list with the dict name and every field of it, including the description of everything

function

For defining functions (or similar) on a language independent manner

Parameters:

• string description: Whatever the function does, it should be on this argument

• string name: Name of the function

Return values:

field

Defines a field of a dict

Parameters:

• string type: String containing the type of the field, for example, field char* my_string cool description

• string name: Name of the field

• string description: Description of the field

param

Document the parameters of a function

Parameters:

• string type: String containing the type of the parameter, for example: char*, bool, table

• string description: Description of the parameter

• string name: Name of the parameter

return

Document the return value of a function

Parameters:

• string type: String containing the type of the return value, for example: size_t, map, function

• string description: Description of the return value

• string name: Name of the return value

Documentation generated by dogen for dogen