我创建了一个带有以下设置的doxygen配置文件(我认为这些设置与我的问题有关(
JAVADOC_AUTOBRIEF=YES
OPTIMIZE_OUTPUT_FOR_JAVA=YES
EXTRACT_ALL=YES
EXTRACT_PRIVATE=YES
EXTRACT_STATIC=YES
EXTRACT_LOCAL_METHODS=YES
我正在记录一个javascript项目。我只想让它在源文件中获取我的JAVASDOC风格的注释。但它不起作用。
下面是一个文件的例子
/// file
export default class FieldController {
constructor(){
}
/// brief A function
/// param A param
/// param Another param
/// return Some return value
method1(){
}
}
找到了。希望这能对其他遇到同样问题的人有所帮助。它现在工作得很好，可以轻松地解析Javascript文件。适用于ES6，开箱即用。
添加以下设置：
EXTENSION_MAPPING = js=JavaScript
如果您有一个由源目录或树组成的较大项目，则应将根目录分配给INPUT标记，并将一个或多个文件模式添加到file_patterns标记(例如*.cpp*.h(。只有与其中一个模式匹配的文件才会被解析
Doxygen根据它解析的文件。使用此标记，您可以指定要用于的解析器给定的扩展。Doxygen有一个内置的映射，但您可以使用此标记覆盖或扩展它。格式为ext=language，其中ext是文件扩展名，language是解析器之一doxygen支持：IDL、Java、JavaScript、Csharp(C#(、C、C++、D、，PHP、md(Markdown(、Objective-C、Python、Slice、VHDL、Fortran(已修复format Fortran:FortranFixed，自由格式Fortran:FortranFree，格式未知的Fortran:Fortran。在后面的情况下，解析器尝试要猜测代码是固定格式代码还是自由格式代码，请使用Fortran类型文件的默认值(。
例如，使doxygen将.inc文件视为Fortran文件(默认值为PHP(，并且.f文件为C(默认值是Fortran(，请使用：inc=Fortran f=C。