chore: Fix documentation generation job: (#5091)

* Add "doxygen" to list of supported branches to allow for testing and
  development.
* Add titles / H1 to some .md files that don't have them.

.github/workflows/doxygen.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - develop
+      - doxygen
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

bin/ci/README.md

@@ -1,3 +1,5 @@
+# Continuous Integration (CI) Scripts
+
 In this directory are two scripts, `build.sh` and `test.sh` used for building
 and testing rippled.
 

cmake/RippledDocs.cmake

@@ -21,15 +21,17 @@ set(doxyfile "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile")
 
 file(GLOB_RECURSE doxygen_input
   docs/*.md
-  src/ripple/*.h
+  include/*.h
-  src/ripple/*.cpp
+  include/*.cpp
-  src/ripple/*.md
+  include/*.md
-  src/test/*.h
+  src/*.h
-  src/test/*.md)
+  src/*.cpp
+  src/*.md
+  Builds/*.md
+  *.md)
 list(APPEND doxygen_input
-  README.md
+  external/README.md
-  RELEASENOTES.md
+  )
-  src/README.md)
 set(dependencies "${doxygen_input}" "${doxyfile}")
 
 function(verbose_find_path variable name)

docs/Doxyfile

@@ -103,18 +103,17 @@ WARN_LOGFILE           =
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
 INPUT                  = \
-    docs \
+    . \
-    src/ripple \
-    src/test \
-    src/README.md \
-    README.md \
-    RELEASENOTES.md \
 
 
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h *.cpp *.md
 RECURSIVE              = YES
-EXCLUDE                =
+EXCLUDE                = \
+    .github \
+    external/ed25519-donna \
+    external/secp256k1 \
+
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
 EXCLUDE_SYMBOLS        =
@@ -130,7 +129,7 @@ INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
 FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE = src/README.md
+USE_MDFILE_AS_MAINPAGE = ./README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

external/README.md

@@ -1,3 +1,5 @@
+# External Conan recipes
+
 The subdirectories in this directory contain either copies or Conan recipes
 of external libraries used by rippled.
 The Conan recipes include patches we have not yet pushed upstream.

include/xrpl/proto/org/xrpl/rpc/v1/README.md

@@ -1,3 +1,5 @@
+# Protocol buffer definitions for gRPC
+
 This folder contains the protocol buffer definitions used by the rippled gRPC API.
 The gRPC API attempts to mimic the JSON/Websocket API as much as possible.
 As of April 2020, the gRPC API supports a subset of the full rippled API:

src/xrpld/app/reporting/README.md

@@ -1,3 +1,5 @@
+# Reporting mode
+
 Reporting mode is a special operating mode of rippled, designed to handle RPCs
 for validated data. A server running in reporting mode does not connect to the
 p2p network, but rather extracts validated data from a node that is connected