Focus Doxygen documentation #8333
Conversation
|
I'm also planning on adding a main page in a later commit |
Doxyfile
Outdated
| @@ -754,7 +754,7 @@ WARN_LOGFILE = | |||
| # spaces. | |||
| # Note: If this tag is empty the current directory is searched. | |||
|
|
|||
| INPUT = . | |||
| INPUT = contrib/epee src | |||
There was a problem hiding this comment.
I'd add easylogging++, qrcode and db_drivers
There was a problem hiding this comment.
This is obviously up for debate, but I decided to not include easylogging++, qrcode, and db_drivers in the documentation since they all have their own separate documentation elsewhere and adding their documentation would just (IMO) clog up Monero's documentation. I can definitely add links to theirs within our docs later on though.
There was a problem hiding this comment.
easylogging++ is definitely under our maintenance now and is quite a large contributor to the compilation time. It would make sense not to hide its complexity.
It's basically exactly the same story as epee
There was a problem hiding this comment.
Agree with mj. Also, adding links to the docs of the other projects would definitely help.
|
I agree with improving Doxygen, given that the first time I opened it, I found that there were to many information not related to the Monero codebase, which does not help beginners that much :) |
| @@ -805,7 +805,7 @@ EXCLUDE_SYMLINKS = NO | |||
| # Note that the wildcards are matched against the file with absolute path, so to | |||
| # exclude all test directories for example use the pattern */test/* | |||
|
|
|||
| EXCLUDE_PATTERNS = */build/* */contrib/depends/* | |||
| EXCLUDE_PATTERNS = */src/crypto/crypto_ops_builder/ref10* | |||
There was a problem hiding this comment.
Because the SUPERCOP ref10 is already documented outside of Monero and it causes a huge disproportionate amount of documentation to be generated
Right now Doxygen is documenting everything in the repo including submodules, everything in contrib, util, tests, etc. This bogs down the documentation to the point where it is very hard to navigate. I think it would be a good move to focus on documenting only the main C++ code which is specific to this repo. Right now this means documenting `src/` (without SUPERCOP), `contrib/epee/`, `external/easylogging++`. After this commit, Doxygen went from running >6000 graphs to about 2200 graphs.
Right now Doxygen is documenting everything in the repo including submodules, everything in contrib, util, tests, etc. This bogs down the documentation to the point where it is very hard to navigate. I think it would be a good move to focus on documenting only the main C++ code which is specific to this repo.
Right now this means documenting
src/(without SUPERCOP) andcontrib/epee/. After this commit, Doxygen went from running >6000 graphs to about 2200 graphs.