docs.doc_gen - jgrey4296/jgrey4296.github.io GitHub Wiki

Documentation Generation

Doxygen

Init/Config

create a config file: doxygen -g can create test/todo lists with \test or \todo, \bug,

uses dot (graphviz)

good things to set in the config: project_name output_directory input file_patterns generate_html extract_all

keywords:

@, \ brief param return class file

YUIDoc

language agnostic

@module @module @class @namespace @param @return @method @property @type @default

Python

use ## and @, rather than python docstyle of three ” INPUT_FILTER = “python /usr/local/bin/doxypy.py”

read the docs

Links

⚠️ **GitHub.com Fallback** ⚠️