Page MenuHomePhabricator

[backport#16912] doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE
ClosedPublic

Authored by PiRK on Oct 22 2020, 19:07.

Details

Reviewers
Fabien
Group Reviewers
Restricted Owners Package(Owns No Changed Paths)
Restricted Project
Commits
rABC9c2f408c3cb4: [backport#16912] doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE
Summary

With USE_MDFILE_AS_MAINPAGE, this moves the introductory Doxygen comment to its own file. This makes bitcoind.cpp cleaner.

It also removes the \mainpage header text, which was smaller than the section titles, and improves the Navigation section.

This is a backport of Core PR16912

Test Plan

ninja doc-doxygen

Diff Detail

Event Timeline

Owners added a reviewer: Restricted Owners Package.Oct 22 2020, 19:07
PiRK requested review of this revision.Oct 22 2020, 19:07
Fabien requested changes to this revision.Oct 22 2020, 20:19
Fabien added a subscriber: Fabien.

Doxyfile.cmake.in is a template to generate the actual Doxyfile.

This revision now requires changes to proceed.Oct 22 2020, 20:19

undo change to developer-notes, run doxygen command in build/

This is a work in progress, I need to have another look at it tomorrow. When i run doxygen doc/Doxyfile in the build directory, I don't get any content on the main page. I need to figure out why.

Fabien requested changes to this revision.Oct 23 2020, 06:07

Clearing my queue

This revision now requires changes to proceed.Oct 23 2020, 06:07

Rebase onto master to include changes in D8074.
Move doc/README_doxygen.md -> doc/doxygen/README.md
Add ${CMAKE_SOURCE_DIR} to the path of the README.md file in Doxyfile.cmake.in

put README.md on its own line

This revision is now accepted and ready to land.Oct 23 2020, 13:28