forked from mia/Aegisub
6ee2f98349
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there. This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style. Some notes: * Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those. * Some multiline comments may have been munged into single line comments * Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them. * Enum comments can go after the enumeration itself '[value] /// comment' * include/aegisub/*.h haven't been converted yet, this will be done in a later commit * Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa. See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'. Originally committed to SVN as r3312. |
||
|---|---|---|
| .. | ||
| automation | ||
| build | ||
| desktop | ||
| libass | ||
| libffms | ||
| m4macros | ||
| packages | ||
| po | ||
| src | ||
| tinderbox | ||
| tools | ||
| universalchardet | ||
| acinclude.m4 | ||
| autogen.sh | ||
| configure.in | ||
| INSTALL | ||
| Makefile.am | ||
| README | ||
* To be written.