Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - Update parameter annotations for consistency #161

Merged
merged 1 commit into from
Nov 17, 2024

Conversation

dpasukhi
Copy link
Member

Reorganized style for param to the next templates:

  • "@param theParameter description ..."
  • "@param[in] theParameter description ..."
  • "@param[out] theParameter description ..."
  • "@param[in][out] theParameter description ..."
    The replacement was with keeping spacing, no removing of extra spaces.
    In some files '/' was used instead of '@', that was not updated yet.

…cade-SAS#161

Reorganized style for param to the next templates:
 - "@param theParameter description ..."
 - "@param[in] theParameter description ..."
 - "@param[out] theParameter description ..."
 - "@param[in][out] theParameter description ..."
 The replacement was with keeping spacing, no removing of extra spaces.
In some files '/' was used instead of '@', that was not updated yet.
@dpasukhi dpasukhi added 1. Documentation Improvements or additions to documentation 2. Enhancement New feature or request labels Nov 17, 2024
@dpasukhi dpasukhi self-assigned this Nov 17, 2024
@dpasukhi dpasukhi merged commit 604c3b8 into Open-Cascade-SAS:IR Nov 17, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1. Documentation Improvements or additions to documentation 2. Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant