Open SunBlack opened 5 years ago
@aPonza you've updated the docs recently. Can you weigh on this please?
The doxyfile was updated (template-wise) as part of #3701, and needs (nice-to-have) a further update since the bump to 20.04 -> Doxygen 1.8.17. Code-wise, the exclude bit is: https://github.com/PointCloudLibrary/pcl/blob/14de3bea4869ac66f48e6815de9ae0402552a59d/doc/doxygen/doxyfile.in#L123-L135
So, easily, we can remove android and test/gtest-1.6.0, whereas I think what was 3rdparty has been moved inside surface completely, right? If that's the case that can be updated as well. @SunBlack was there any other bit you remember being completely bonkers? From a quick scan that seems to be the only real problem apart from the old template you might have seen and which can be updated as well now.
BTW I was noticing while trying to get the dot graph to appear that the doxygen_layout.xml is almost the default except for ordering (do we care?) and, after updating the layout template and factoring out the ordering, this diff:
--- ./test/doxygen_layout.xml
+++ ./test/default_layout.xml
@@ -29,11 +29,11 @@
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
</tab>
- <tab type="files" visible="no" title="">
+ <tab type="files" visible="yes" title="">
<tab type="filelist" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
- <tab type="examples" visible="no" title="" intro=""/>
+ <tab type="examples" visible="yes" title="" intro=""/>
</navindex>
<!-- Layout definition for a class page -->
@@ -128,7 +128,7 @@
<!-- Layout definition for a file page -->
<file>
- <briefdescription visible="no"/>
+ <briefdescription visible="yes"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
@@ -215,11 +215,11 @@
<!-- Layout definition for a directory page -->
<directory>
- <briefdescription visible="no"/>
- <directorygraph visible="no"/>
- <memberdecl>
- <dirs visible="no"/>
- <files visible="no"/>
+ <briefdescription visible="yes"/>
+ <directorygraph visible="yes"/>
+ <memberdecl>
+ <dirs visible="yes"/>
+ <files visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
</directory>
and again the question is: do we care?
The
doxyfile.in
is outdated. E.g. most entries inEXCLUDE
are not correct or needed anymore. So maybe someone, who is using the documentation, should update this script.