Skip to content

DPF(C++): First try for a Markdown DPF C++ API doc 2027R1#313

Open
PProfizi wants to merge 4 commits intomainfrom
DPF/2027R1/dpf-cpp-doc_try
Open

DPF(C++): First try for a Markdown DPF C++ API doc 2027R1#313
PProfizi wants to merge 4 commits intomainfrom
DPF/2027R1/dpf-cpp-doc_try

Conversation

@PProfizi
Copy link
Contributor

No description provided.

@PProfizi PProfizi self-assigned this Feb 11, 2026
@PProfizi
Copy link
Contributor Author

  • There must be only one main final toc.yml
  • Change Markdown file names to have: no numbers, no underscore (use dashes), and no capital letters

@PProfizi
Copy link
Contributor Author

PProfizi commented Feb 12, 2026

The process is correct if:

  • Doxygen only treats the API reference, leave the original Markdown doc source alone
  • Make sure Doxygen is the right version
  • Seaborg translates only the Doxygen output
  • Ansys Doxygen config should still be the one from the repo api_documentation (branch to confirm)
  • Try and use Seaborg config to filter-out protected and private members (which Doxygen does not do for XML despite its config saying not to). Beware the Seaborg config may not work either.

@PProfizi
Copy link
Contributor Author

Try seaborg-config.json:

{
    "excludeProtectionLevels":  [
                                    "private",
                                    "protected"
                                ]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant