Nomenclature: "alias" -> "spec" (2) - #37
Merged
Merged
Conversation
…p_lookup_spec_for_name_()`
…> `clasp_check_spec_duplicates_()`
…_()` => `clasp_is_valid_spec_section_range_()`
synesissoftware
approved these changes
Sep 20, 2026
synesissoftware
added a commit
that referenced
this pull request
Sep 20, 2026
* Doxygen (#32) * docs(clasp): add Doxygen packaging aligned with peer C libraries Add **Doxyfile**, **doc/mainpage.md**, and **generate_doxygen.sh** (cstring form, loading **.sis/project_name.txt**) so HTML API docs generate under `_build/doxygen/`; document the flow in **README.md**; define missing `group__utility` in **clasp.h**; * docs(clasp): eliminate public-header Doxygen warnings Correct Doxygen annotations and declarations across the public API: * align `\param` names with signatures and document omitted API parameters; * replace invalid `\exceptions` markup with `\exception <any>`; * introduce `clasp::main::pfnMain_t` so Doxygen parses callback overloads; * refresh touched-header metadata and clarify the `invoke()` implementation; * docs(clasp): normalise Doxygen parameter clauses Normalise all 263 `\param` clauses across public and implementation headers: * terminate every clause with a semicolon; * mark every null pointer spelling as `\c NULL`; * apply consistent indentation and greedy 76-column wrapping; * refresh metadata in touched source and utility-header files; * ci(clasp): reject Doxygen documentation warnings Add a dedicated Linux documentation job modelled on **p99** and invoking the peer-aligned generation helper: * install Doxygen and verify generated HTML output; * enable `WARN_AS_ERROR` so documentation warnings fail generation; * preserve Doxygen's exit status in **generate_doxygen.sh**; * Nomenclature: "alias" -> "spec" (#33) * docs(clasp): add Doxygen packaging aligned with peer C libraries Add **Doxyfile**, **doc/mainpage.md**, and **generate_doxygen.sh** (cstring form, loading **.sis/project_name.txt**) so HTML API docs generate under `_build/doxygen/`; document the flow in **README.md**; define missing `group__utility` in **clasp.h**; * docs(clasp): eliminate public-header Doxygen warnings Correct Doxygen annotations and declarations across the public API: * align `\param` names with signatures and document omitted API parameters; * replace invalid `\exceptions` markup with `\exception <any>`; * introduce `clasp::main::pfnMain_t` so Doxygen parses callback overloads; * refresh touched-header metadata and clarify the `invoke()` implementation; * docs(clasp): normalise Doxygen parameter clauses Normalise all 263 `\param` clauses across public and implementation headers: * terminate every clause with a semicolon; * mark every null pointer spelling as `\c NULL`; * apply consistent indentation and greedy 76-column wrapping; * refresh metadata in touched source and utility-header files; * ci(clasp): reject Doxygen documentation warnings Add a dedicated Linux documentation job modelled on **p99** and invoking the peer-aligned generation helper: * install Doxygen and verify generated HTML output; * enable `WARN_AS_ERROR` so documentation warnings fail generation; * preserve Doxygen's exit status in **generate_doxygen.sh**; * chore(implementation): replaced instances of deprecated `clasp_alias_t` with `clasp_specification_t` * chore(implementation): standardised first-character tests * docs(clasp): apply greedy 76-column wrapping to comments Rewrap strategic and Doxygen block comments in include/clasp and src so each continued line is packed to 76 columns; leave trailing inline comments, license text, diagrams, and unbreakable constructs (\link, signatures, paths) intact; refresh Updated/copyright on files that were still stale; * chore(implementation): replaced instances of deprecated `alias` with `specification` * squash-commit * Polish (#34) * chore(main.hpp): minimal preparatory polish * refactor(clasp): use C++ namespace type aliases; release 0.15.3 Spell C API types as `char_t`, `arguments_t`, `argument_t`, and `usageinfo_t` in the C++ layer (`clasp.h`, `clasp.hpp`, `main.hpp`, `search_specifications.hpp`); bump **CLASP_VER_PATCH** to 3. * markdown * squash-commit * Nomenclature: "alias" -> "spec" (2) (#37) * chore(implementation): replaced instances of `alias` with `spec` * refactor(implementation): renamed `clasp_lookup_spec_len_()` => `clasp_lookup_spec_for_name_()` * chore(layout): vertical whitespace * refactor(implementation): renamed `flagAlias` => `flagSpec` * chore(implementation): replaced instances of `alias` with `spec` * chore(implementation): refactoring implementation helper names * refactor(implementation): renamed `clasp_check_alias_duplicates_()` => `clasp_check_spec_duplicates_()` * refactor(implementation): renamed `clasp_is_valid_alias_section_range_()` => `clasp_is_valid_spec_section_range_()` * doc * chore(implementation): doc --------- Co-authored-by: Matt Wilson <152443343+mwsis@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.