doxygen作为文档处理器

Question

是否可以禁用Doxygen的所有代码检查功能？

我的意思是：删除所有类/功能/变量/等。 doxygen收集分析源，同时保持所有文档以此类的明确标记（\ page，\ subpage，\ e节，\ subsect /code>等），即：所有将涉及\ mainpage和朋友的一切，而没有任何“名称空间”，“类”和“文件”。

理想情况下，应该在doxyfile级别上进行此选择，而不是编辑来源。

这个请求背后的原因是我使用doxygen生成文档（当然！），我想制作类似“执行摘要”之类的东西，我可以在其中解释不用实际API的情况下应该做什么（更不用说如何它完成了）。

我目前正在这样做，只是切割.pdf我生产的，但这确实很难手动是“次优”）。

注意：i did 阅读所有doxyfile由> doxygen -g生成的，但我没有发现任何有用的东西；仅在Margimal上有用的是：alphabientic_index = no和lastx_hide_indices = yes。

更新：遵循@albert咨询（谢谢！）我尝试用layout_file弄乱，但是我无法使它起作用（这是可惜的

我当前的尝试是：

<doxygenlayout version="1.0">
  <!-- Generated by doxygen 1.9.5 -->
  <!-- Navigation index tabs for HTML output -->
  <navindex>
    <tab type="mainpage" visible="yes" title=""/>
    <tab type="pages" visible="yes" title="" intro=""/>
    <tab type="modules" visible="no" title="" intro=""/>
    <tab type="namespaces" visible="no" title="">
      <tab type="namespacelist" visible="no" title="" intro=""/>
      <tab type="namespacemembers" visible="no" title="" intro=""/>
    </tab>
    <tab type="concepts" visible="no" title="">
    </tab>
    <tab type="interfaces" visible="no" title="">
      <tab type="interfacelist" visible="no" title="" intro=""/>
      <tab type="interfaceindex" visible="no" title=""/>
      <tab type="interfacehierarchy" visible="no" title="" intro=""/>
    </tab>
    <tab type="classes" visible="no" title="">
      <tab type="classlist" visible="no" title="" intro=""/>
      <tab type="classindex" visible="no" title=""/>
      <tab type="hierarchy" visible="no" title="" intro=""/>
      <tab type="classmembers" visible="no" title="" intro=""/>
    </tab>
    <tab type="structs" visible="no" title="">
      <tab type="structlist" visible="no" title="" intro=""/>
      <tab type="structindex" visible="no" title=""/>
    </tab>
    <tab type="exceptions" visible="no" title="">
      <tab type="exceptionlist" visible="no" title="" intro=""/>
      <tab type="exceptionindex" visible="no" title=""/>
      <tab type="exceptionhierarchy" visible="no" title="" intro=""/>
    </tab>
    <tab type="files" visible="no" title="">
      <tab type="filelist" visible="no" title="" intro=""/>
      <tab type="globals" visible="no" title="" intro=""/>
    </tab>
    <tab type="examples" visible="no" title="" intro=""/>
  </navindex>

  <!-- Layout definition for a class page -->
  <class visible="no">
    <briefdescription visible="no"/>
    <includes visible="no"/>
    <inheritancegraph visible="no"/>
    <collaborationgraph visible="no"/>
    <memberdecl>
      <nestedclasses visible="no" title=""/>
      <publictypes title=""/>
      <services title=""/>
      <interfaces title=""/>
      <publicslots title=""/>
      <signals title=""/>
      <publicmethods title=""/>
      <publicstaticmethods title=""/>
      <publicattributes title=""/>
      <publicstaticattributes title=""/>
      <protectedtypes title=""/>
      <protectedslots title=""/>
      <protectedmethods title=""/>
      <protectedstaticmethods title=""/>
      <protectedattributes title=""/>
      <protectedstaticattributes title=""/>
      <packagetypes title=""/>
      <packagemethods title=""/>
      <packagestaticmethods title=""/>
      <packageattributes title=""/>
      <packagestaticattributes title=""/>
      <properties title=""/>
      <events title=""/>
      <privatetypes title=""/>
      <privateslots title=""/>
      <privatemethods title=""/>
      <privatestaticmethods title=""/>
      <privateattributes title=""/>
      <privatestaticattributes title=""/>
      <friends title=""/>
      <related title="" subtitle=""/>
      <membergroups visible="no"/>
    </memberdecl>
    <detaileddescription title=""/>
    <memberdef>
      <inlineclasses title=""/>
      <typedefs title=""/>
      <enums title=""/>
      <services title=""/>
      <interfaces title=""/>
      <constructors title=""/>
      <functions title=""/>
      <related title=""/>
      <variables title=""/>
      <properties title=""/>
      <events title=""/>
    </memberdef>
    <allmemberslink visible="no"/>
    <usedfiles visible="no"/>
    <authorsection visible="no"/>
  </class>

  <!-- Layout definition for a namespace page -->
  <namespace visible="no">
    <briefdescription visible="no"/>
    <memberdecl>
      <nestednamespaces visible="no" title=""/>
      <constantgroups visible="no" title=""/>
      <interfaces visible="no" title=""/>
      <classes visible="no" title=""/>
      <concepts visible="no" title=""/>
      <structs visible="no" title=""/>
      <exceptions visible="no" title=""/>
      <typedefs title=""/>
      <sequences title=""/>
      <dictionaries title=""/>
      <enums title=""/>
      <functions title=""/>
      <variables title=""/>
      <membergroups visible="no"/>
    </memberdecl>
    <detaileddescription title=""/>
    <memberdef>
      <inlineclasses title=""/>
      <typedefs title=""/>
      <sequences title=""/>
      <dictionaries title=""/>
      <enums title=""/>
      <functions title=""/>
      <variables title=""/>
    </memberdef>
    <authorsection visible="no"/>
  </namespace>

  <!-- Layout definition for a concept page -->
  <concept visible="no">
    <briefdescription visible="no"/>
    <includes visible="no"/>
    <definition visible="no" title=""/>
    <detaileddescription title=""/>
    <authorsection visible="no"/>
  </concept>

  <!-- Layout definition for a file page -->
  <file visible="no">
    <briefdescription visible="no"/>
    <includes visible="no"/>
    <includegraph visible="no"/>
    <includedbygraph visible="no"/>
    <sourcelink visible="no"/>
    <memberdecl>
      <interfaces visible="no" title=""/>
      <classes visible="no" title=""/>
      <structs visible="no" title=""/>
      <exceptions visible="no" title=""/>
      <namespaces visible="no" title=""/>
      <concepts visible="no" title=""/>
      <constantgroups visible="no" title=""/>
      <defines title=""/>
      <typedefs title=""/>
      <sequences title=""/>
      <dictionaries title=""/>
      <enums title=""/>
      <functions title=""/>
      <variables title=""/>
      <membergroups visible="no"/>
    </memberdecl>
    <detaileddescription title=""/>
    <memberdef>
      <inlineclasses title=""/>
      <defines title=""/>
      <typedefs title=""/>
      <sequences title=""/>
      <dictionaries title=""/>
      <enums title=""/>
      <functions title=""/>
      <variables title=""/>
    </memberdef>
    <authorsection/>
  </file>

  <!-- Layout definition for a group page -->
  <group visible="no">
    <briefdescription visible="no"/>
    <groupgraph visible="no"/>
    <memberdecl>
      <nestedgroups visible="no" title=""/>
      <dirs visible="no" title=""/>
      <files visible="no" title=""/>
      <namespaces visible="no" title=""/>
      <concepts visible="no" title=""/>
      <classes visible="no" title=""/>
      <defines title=""/>
      <typedefs title=""/>
      <sequences title=""/>
      <dictionaries title=""/>
      <enums title=""/>
      <enumvalues title=""/>
      <functions title=""/>
      <variables title=""/>
      <signals title=""/>
      <publicslots title=""/>
      <protectedslots title=""/>
      <privateslots title=""/>
      <events title=""/>
      <properties title=""/>
      <friends title=""/>
      <membergroups visible="no"/>
    </memberdecl>
    <detaileddescription title=""/>
    <memberdef>
      <pagedocs/>
      <inlineclasses title=""/>
      <defines title=""/>
      <typedefs title=""/>
      <sequences title=""/>
      <dictionaries title=""/>
      <enums title=""/>
      <enumvalues title=""/>
      <functions title=""/>
      <variables title=""/>
      <signals title=""/>
      <publicslots title=""/>
      <protectedslots title=""/>
      <privateslots title=""/>
      <events title=""/>
      <properties title=""/>
      <friends title=""/>
    </memberdef>
    <authorsection visible="no"/>
  </group>

  <!-- Layout definition for a directory page -->
  <directory visible="no">
    <briefdescription visible="no"/>
    <directorygraph visible="no"/>
    <memberdecl>
      <dirs visible="no"/>
      <files visible="no"/>
    </memberdecl>
    <detaileddescription title=""/>
  </directory>
</doxygenlayout>

不幸的是，所有可见属性>不幸

的是，唯一的荣誉的地方是＆lt; navindex 使用了布局文件）

/代码>（实际上

。 “否” 在＆lt; class＆gt;上也没有效果

。

Answer 1

我使用以下脚本取得了部分成功：

#!/bin/bash
set +e

cat > tmp.doxyfile <<EOF
PROJECT_NAME           = "My Awesome Project"
QUIET                  = YES
EXTRACT_ALL            = YES
EXTRACT_STATIC         = YES
JAVADOC_AUTOBRIEF      = YES
RECURSIVE              = YES
INPUT                  = ../src/
EXAMPLE_PATH           = ../src/
PLANTUML_JAR_PATH      = /usr/local/bin/plantuml.jar

PROJECT_NUMBER = "version in git: $(git describe --always --dirty --long)"

ALPHABETICAL_INDEX     = NO
LATEX_HIDE_INDICES     = YES
UML_LOOK               = YES
EXTRACT_LOCAL_CLASSES  = YES
SHOW_HEADERFILE        = NO
VERBATIM_HEADERS       = NO
FULL_PATH_NAMES        = NO

GENERATE_HTML          = NO

LAYOUT_FILE            = tmp.layout.xml
EOF

cat > tmp.layout.xml <<EOF
<doxygenlayout version="1.0">
  <!-- Generated by doxygen 1.9.5 -->
  <!-- Navigation index tabs for HTML output -->
  <navindex>
    <tab type="mainpage" visible="yes" title=""/>
    <tab type="pages" visible="yes" title="" intro=""/>
  </navindex>

  <!-- Layout definition for a class page -->
  <class visible="no">
    <briefdescription visible="yes"/>
  </class>

  <!-- Layout definition for a namespace page -->
  <namespace visible="no">
    <briefdescription visible="yes"/>
  </namespace>

  <!-- Layout definition for a concept page -->
  <concept visible="no">
    <briefdescription visible="yes"/>
  </concept>

  <!-- Layout definition for a file page -->
  <file visible="no">
    <briefdescription visible="yes"/>
  </file>

  <!-- Layout definition for a group page -->
  <group visible="no">
    <briefdescription visible="yes"/>
  </group>

  <!-- Layout definition for a directory page -->
  <directory visible="no">
    <briefdescription visible="yes"/>
  </directory>
</doxygenlayout>
EOF
rm -r html latex
doxygen tmp.doxyfile
rm tmp.doxyfile tmp.layout.xml
cat > tmp.doxyfile <<EOF
PROJECT_NAME           = "My Awesome Project"
QUIET                  = YES
EXTRACT_ALL            = YES
EXTRACT_STATIC         = YES
JAVADOC_AUTOBRIEF      = YES
RECURSIVE              = YES
INPUT                  = ../src/
EXAMPLE_PATH           = ../src/
CALL_GRAPH             = YES
PLANTUML_JAR_PATH      = /usr/local/bin/plantuml.jar

DISABLE_INDEX          = YES
GENERATE_TREEVIEW      = YES
GENERATE_LATEX         = NO

PROJECT_NUMBER = "version in git: $(git describe --always --dirty --long)"
EOF
doxygen tmp.doxyfile
rm tmp.doxyfile
[ -f doc.zip ] && rm doc.zip
( cd latex && make )>/dev/null && zip -rq doc.zip latex/refman.pdf html/

这将创建一个“完整的” HTML版本和“执行摘要”乳胶版本。这是可以接受的，但仍然不令人满意，原因有两个：

1. 我是通过删除它们来“隐藏”部分，而这是doxygen手册中的“不推荐” ... OTOH我找到了拥有可见>可见属性的方法我。
2. 我仍然必须至少保留＆lt; hiqueDescription visible =“ yes”/＆gt;在所有部分中，因为否则默认值都会启动。

我不会在几天内接受我自己的答案，希望有人可以提出一个更好的解决方案。