Christopher M. Punches
11aad23e80
src/documentation.cpp is the documentation loading source: it carries no code and names each document that the generated reference contains, in order, by page label. The labels are declared on each markdown file's first heading. The build configuration lists the files as Doxygen inputs and nothing more, so the structure of the documentation and the mechanics of generating it are separate. The hand-maintained document index at the end of OVERVIEW.md is gone, along with the last references to markdown files by filename in the public header. The document list exists in one place. The docs target clears its output and scratch directories on every run. Doxygen keeps output files it judges unchanged, so a run over a populated scratch directory carried pages forward from earlier ones, and removed sections survived in the generated HTML and PDF after their source was edited.
54 lines
1.7 KiB
C++
54 lines
1.7 KiB
C++
/**
|
|
* @file documentation.cpp
|
|
* @brief Documentation loading source: declares the reference's pages
|
|
*
|
|
* This file carries no code. It declares what the generated reference
|
|
* contains and in what order, so the structure of the documentation
|
|
* lives in a source file of its own rather than in the build
|
|
* configuration.
|
|
*
|
|
* Each entry in the main page names a document by its page label,
|
|
* declared on the first heading of the corresponding markdown file in
|
|
* docs/.
|
|
*
|
|
* @copyright Copyright (c) 2026 SILO GROUP LLC
|
|
* @author Chris Punches <chris.punches@silogroup.org>
|
|
*
|
|
* Part of the Dark Horse Linux Package Manager (DPM)
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* @mainpage DPM
|
|
*
|
|
* Dark Horse Linux Package Manager: libdpm-core.so, the dpm binary, and
|
|
* the modules that implement package functionality.
|
|
*
|
|
* The documents below carry the project's prose. The API and internals
|
|
* reference extracted from the source follows them.
|
|
*
|
|
* @subpage overview
|
|
*
|
|
* @subpage design
|
|
*
|
|
* @subpage consumers
|
|
*
|
|
* @subpage modules
|
|
*
|
|
* @subpage build
|
|
*
|
|
* @subpage documentation
|
|
*/
|
