Apache Версия 2.0 Сервера HTTP
Apacheские 2.0 использования Doxygen документировать ПЧЕЛУ и глобальные переменные в кодекс. Это объяснит основы того, как документировать использование Doxygen.
начинать блок документации, использование
/**
заканчивать блок документации, использование
*/
в середине блока, есть многократные признаки, которые мы можем использовать:
Description of this functions purpose
@param parameter_name description
@return description
@deffunc signature of the function
deffunc
не всегда необходимо. DoxyGen не имеет полного анализатора в этом, таким образом любой опытный образец, которые используют макрос в декларации типа возвращения, слишком сложен для scandoc. Те функции требуют a
deffunc
. пример (использующий > а не >):
/**
* return the final element of the pathname
* @param pathname The path to get the final element of
* @return the final element of the path
* @tip Examples:
* <pre>
* "/foo/bar/gum" -> "gum"
* "/foo/bar/gum/" -> ""
* "gum" -> "gum"
* "wi\\n32\\stuff" -> "stuff"
* </pre>
* @deffunc const char * ap_filename_of_pathname(const char *pathname)
*/
наверху файла удара головой, всегда включите:
/**
* @package Name of library header
*/
Доксиджен использует новый файл HTML для каждого пакета. Файлы HTML называют {Name_of_library_header} .html, так пробуйте быть кратким с вашими названиями.
поскольку дальнейшее обсуждение возможностей пожалуйста обратитесь к the Doxygen site .