Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

update Doxygen config and run auto doc update on F34#1074

Closed
lukaszstolarczuk wants to merge 4 commits intopmem:masterfrom
lukaszstolarczuk:update-doxygen-config
Closed

update Doxygen config and run auto doc update on F34#1074
lukaszstolarczuk wants to merge 4 commits intopmem:masterfrom
lukaszstolarczuk:update-doxygen-config

Conversation

@lukaszstolarczuk
Copy link
Copy Markdown
Member

@lukaszstolarczuk lukaszstolarczuk commented May 5, 2021

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 Reviewable

@codecov
Copy link
Copy Markdown

codecov bot commented May 5, 2021

Codecov Report

Merging #1074 (e4b82b3) into master (2a0b54f) will decrease coverage by 0.28%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            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     
Flag Coverage Δ
tests_clang_debug_cpp17 93.18% <0.00%> (-0.31%) ⬇️
tests_gcc_debug 91.47% <0.00%> (-0.35%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...j++/container/detail/concurrent_skip_list_impl.hpp 97.02% <ø> (+0.02%) ⬆️
include/libpmemobj++/detail/ctl.hpp 100.00% <ø> (ø)
include/libpmemobj++/detail/pair.hpp 100.00% <ø> (ø)
...nclude/libpmemobj++/detail/persistent_pool_ptr.hpp 100.00% <ø> (ø)
include/libpmemobj++/detail/tagged_ptr.hpp 100.00% <ø> (ø)
include/libpmemobj++/detail/temp_value.hpp 100.00% <ø> (ø)
...memobj++/experimental/atomic_self_relative_ptr.hpp 100.00% <ø> (ø)
...clude/libpmemobj++/experimental/concurrent_map.hpp 100.00% <ø> (ø)
...nclude/libpmemobj++/experimental/inline_string.hpp 98.57% <ø> (-0.06%) ⬇️
include/libpmemobj++/pexceptions.hpp 34.92% <0.00%> (-9.70%) ⬇️
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a0b54f...e4b82b3. Read the comment docs.

Copy link
Copy Markdown

@karczex karczex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@lukaszstolarczuk lukaszstolarczuk marked this pull request as draft May 6, 2021 09:40
@lukaszstolarczuk lukaszstolarczuk force-pushed the update-doxygen-config branch from 5aa793b to d68d21c Compare May 6, 2021 09:55
@lukaszstolarczuk lukaszstolarczuk changed the title doc: update Doxygen config file to new format update Doxygen config and run auto doc update on F34 May 6, 2021
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.
@lukaszstolarczuk lukaszstolarczuk force-pushed the update-doxygen-config branch from d68d21c to 6545717 Compare May 21, 2021 12:34
@lukaszstolarczuk lukaszstolarczuk force-pushed the update-doxygen-config branch 6 times, most recently from 5c0dbe6 to b7bd10c Compare May 25, 2021 11:11
@lukaszstolarczuk lukaszstolarczuk force-pushed the update-doxygen-config branch from b7bd10c to e4b82b3 Compare May 25, 2021 11:15
@lukaszstolarczuk lukaszstolarczuk marked this pull request as ready for review May 25, 2021 11:24
Copy link
Copy Markdown
Member Author

@lukaszstolarczuk lukaszstolarczuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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...

Copy link
Copy Markdown
Contributor

@KFilipek KFilipek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 18 of 18 files at r2.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @karczex)

Copy link
Copy Markdown
Contributor

@igchor igchor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:, please just rebase to include changes in inline_string

Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @karczex)

@lukaszstolarczuk
Copy link
Copy Markdown
Member Author

continued in linked (above) PR

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants