Details

Reviewers

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

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

PiRK created this revision.Oct 22 2020, 19:07

Owners added a reviewer: Restricted Owners Package.Oct 22 2020, 19:07

Herald added a reviewer: Restricted Project. · View Herald TranscriptOct 22 2020, 19:07

PiRK requested review of this revision.Oct 22 2020, 19:07

teamcity edited the summary of this revision. (Show Details)Oct 22 2020, 19:07

Harbormaster completed remote builds in B13603: Diff 24958.Oct 22 2020, 19:17

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

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

PiRK edited the test plan for this revision. (Show Details)Oct 22 2020, 20:26

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.

Harbormaster completed remote builds in B13605: Diff 24975.Oct 22 2020, 20:44

Clearing my queue

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

PiRK edited the test plan for this revision. (Show Details)Oct 23 2020, 08:44

Fabien mentioned this in D8074: [CMAKE] Fix doxygen generation.Oct 23 2020, 09:20

Fabien mentioned this in rABCae5a6890d31f: [CMAKE] Fix doxygen generation.Oct 23 2020, 12:19

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

Harbormaster completed remote builds in B13627: Diff 25013.Oct 23 2020, 13:08

PiRK edited the test plan for this revision. (Show Details)Oct 23 2020, 13:09

put README.md on its own line

Fabien accepted this revision.Oct 23 2020, 13:28

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

Harbormaster completed remote builds in B13629: Diff 25016.Oct 23 2020, 13:40

Closed by commit rABC9c2f408c3cb4: [backport#16912] doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE (authored by Jon Layton <me@jonl.io>, committed by PiRK). · Explain WhyOct 23 2020, 14:46

This revision was automatically updated to reflect the committed changes.

PiRK added a commit: rABC9c2f408c3cb4: [backport#16912] doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE.