search

erez-o / docsforge

Modern C/C++ documentation generator for open source projects.
https://docsforge.com/
27 stars 1 forks source link

Title of \pre and \post paragraphs #31

Closed gennaroprota closed 3 years ago

gennaroprota commented 3 years ago

Hi,

it seems that DocsForge correctly renders \pre and \post documentation with separate paragraphs but gets their titles wrong; see the attached image.

screenshotForDocsForgeIssue

erez-o commented 3 years ago

Thanks for reporting, I'll check on it.

gennaroprota commented 3 years ago

Thank *you*!

erez-o commented 3 years ago

Fixed and released on version 3.4.17.

/pre and /post titles are now rendered with titles Precondition and Postcondition.

Closing issue, please reopen if you find any problems. Cheers :)

gennaroprota commented 3 years ago

Thanks. To let my pedantic self get completely out :-), I'd prefer the plural, in this case ("Preconditions" and "Postconditions"), but I'll leave it up to you. Doxygen uses the singular. "Precondition" could also be replaced with "Requires", and "Postcondition" with "Ensures", but that's probably deviating too much from what people are used to by using Doxygen.

erez-o commented 3 years ago

:) I agree, but currently it's better if I'm consistent with Doxygen regarding this issue.