Dark-Horse-Linux/dpm-core-ng
3
0
Fork 0
Code Issues Pull Requests Actions Activity

Title-case every page and section heading

Browse Source 
DPM is public-facing, and its headings read as titles: capitalized
throughout, with articles, conjunctions, and short prepositions left
lowercase in the middle.

Applies to the markdown documents and to the Doxygen page and section
titles in the public header, so the generated reference matches. One
prose cross-reference in DESIGN.md follows the section it names.
This commit is contained in:
Chris Punches
2026-08-15 20:49:29 -04:00
parent 38bd9314cc
commit 99173d27ea
6 changed files with 57 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/dpm/core.h
View File

@@ -321,7 +321,7 @@ DPM_API const char* dpm_last_error(dpm_ctx* ctx);
/* ------------------------------------------------------------------ */
/**
* @mainpage libdpm-core.so — API reference
* @mainpage libdpm-core.so — API Reference
*
* This is the generated reference for libdpm-core.so, extracted from
* the source. It covers the public C API in <dpm/core.h>, the library's
@@ -336,7 +336,7 @@ DPM_API const char* dpm_last_error(dpm_ctx* ctx);
*/
/**
* @page module_contract The module contract
* @page module_contract The Module Contract
*
* A module is one .so in the module directory. It includes
* <dpm/core.h>, links -ldpm-core, and exports three reserved symbols as
@@ -349,14 +349,14 @@ DPM_API const char* dpm_last_error(dpm_ctx* ctx);
* const char* dpm_module_description(void);
* @endcode
*
* @section module_contract_surface The functional surface
* @section module_contract_surface The Functional Surface
*
* dpm_module_execute is the module's entire functional surface; its
* capabilities are addressed by command string, so a module publishes
* no headers, struct layouts, or symbols to anything that calls it.
* NULL or an empty command behaves as the module's help command.
*
* @section module_contract_version Version compatibility
* @section module_contract_version Version Compatibility
*
* A module determines for itself whether it can work with the library
* it is running against: dpm_core_version() reports the running