update Doxygen config and run auto doc update on F34#1074
update Doxygen config and run auto doc update on F34#1074lukaszstolarczuk wants to merge 4 commits intopmem:masterfrom
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1074 +/- ##
==========================================
- Coverage 94.07% 93.79% -0.29%
==========================================
Files 49 49
Lines 4726 4670 -56
==========================================
- Hits 4446 4380 -66
- Misses 280 290 +10
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
karczex
left a comment
There was a problem hiding this comment.
Reviewable status: 0 of 1 files reviewed, 5 unresolved discussions (waiting on @lukaszstolarczuk)
doc/libpmemobj++.Doxyfile.in, line 154 at r1 (raw file):
# The default value is: NO. INLINE_INHERITED_MEMB = NO
We probably should enable it to properly display documentation for pool.
doc/libpmemobj++.Doxyfile.in, line 474 at r1 (raw file):
# Minimum value: 0, maximum value: 32, default value: 1. NUM_PROC_THREADS = 1
Did you test, how setting it to 0 fits into libpmemobj-cpp build system when building
make -j$(nproc)
?
doc/libpmemobj++.Doxyfile.in, line 552 at r1 (raw file):
# The default value is: NO. HIDE_UNDOC_MEMBERS = YES
Are you sure it should be enabled?
doc/libpmemobj++.Doxyfile.in, line 1119 at r1 (raw file):
# The default value is: NO. CLANG_ASSISTED_PARSING = NO
Probably not for this PR, but it may be good idea to enable this option.
doc/libpmemobj++.Doxyfile.in, line 2316 at r1 (raw file):
# The default value is: NO. HAVE_DOT = NO
We should check what happened if we enable this, and some related options
5aa793b to
d68d21c
Compare
it has doxygen in version 1.9.x, which produces better documentation. Also, removed additional 'hub --version' step in the auto-doc-update script, since it appears to be redundant.
using Doxygen 1.9.1 version.
d68d21c to
6545717
Compare
5c0dbe6 to
b7bd10c
Compare
b7bd10c to
e4b82b3
Compare
lukaszstolarczuk
left a comment
There was a problem hiding this comment.
Reviewable status: 0 of 18 files reviewed, 3 unresolved discussions (waiting on @karczex)
doc/libpmemobj++.Doxyfile.in, line 154 at r1 (raw file):
Previously, karczex (Paweł Karczewski) wrote…
We probably should enable it to properly display documentation for pool.
Done.
doc/libpmemobj++.Doxyfile.in, line 474 at r1 (raw file):
Previously, karczex (Paweł Karczewski) wrote…
Did you test, how setting it to 0 fits into libpmemobj-cpp build system when building
make -j$(nproc)?
I'm not sure if we can do anything to make "-j" speed our docs building, but:
- I've set the above variable to 0, so it should take all the available cores
- docs are built within 10 seconds, so it's not a biggie, I believe
doc/libpmemobj++.Doxyfile.in, line 552 at r1 (raw file):
Previously, karczex (Paweł Karczewski) wrote…
Are you sure it should be enabled?
Done.
doc/libpmemobj++.Doxyfile.in, line 1119 at r1 (raw file):
Previously, karczex (Paweł Karczewski) wrote…
Probably not for this PR, but it may be good idea to enable this option.
I've tried and:
- there were so many issues with this approach
- when I finally made it work, it wasn't worth it - I didn't see any improvements
doc/libpmemobj++.Doxyfile.in, line 2316 at r1 (raw file):
Previously, karczex (Paweł Karczewski) wrote…
We should check what happened if we enable this, and some related options
graphs look ok, enabled it
doc/libpmemobj++.Doxyfile.in, line 841 at r2 (raw file):
# XXX: temporarily disabled, until all members are documented # or unneeded files are turned off (from doxygen) #WARN_AS_ERROR = @DOXYGEN_WARN_AS_ERROR@
temporarily disabled, until we skip all the docs we don't want to include or we add all the missing docs :)
doc/libpmemobj++.Doxyfile.in, line 1546 at r2 (raw file):
# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES
this is the new tree on the left-hand side of the docs - pls let me know if we want to keep it...
KFilipek
left a comment
There was a problem hiding this comment.
Reviewed 18 of 18 files at r2.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @karczex)
igchor
left a comment
There was a problem hiding this comment.
, please just rebase to include changes in inline_string
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @karczex)
|
continued in linked (above) PR |
A new config file format is updated automatically using Doxygen 1.9.1 (
doxygen -u <file>command).And additional extra changes to fix some docs issues.
Preview: https://lukaszstolarczuk.github.io/libpmemobj-cpp/master/doxygen/index.html
This change is