Skip to content

DOC: Print backslash mark#167

Merged
thewtex merged 1 commit intoInsightSoftwareConsortium:masterfrom
jhlegarreta:PrinBackslashMark
Nov 29, 2021
Merged

DOC: Print backslash mark#167
thewtex merged 1 commit intoInsightSoftwareConsortium:masterfrom
jhlegarreta:PrinBackslashMark

Conversation

@jhlegarreta
Copy link
Member

Print backslash mark.

Fixes:

Note that ITK prefers the backslash ("
") style versus the at-sign (“@”) style to write the documentation command

and

When documenting a class header, if citations are required, use the Doxygen
`par References` command to list the references in a separate and
clearly visible paragraph

Use the code command for the at-sign as well for the sake of
consistency.

Print backslash mark.

Fixes:
```
Note that ITK prefers the backslash ("
") style versus the at-sign (“@”) style to write the documentation command
```

and
```
When documenting a class header, if citations are required, use the Doxygen
`par References` command to list the references in a separate and
clearly visible paragraph
```

Use the `code` command for the at-sign as well for the sake of
consistency.
@github-actions github-actions bot added area:Appendices Issues affecting the Appendices part area:Documentation Issues affecting the Documentation module language:LaTeX Changes to LaTeX code type:BookStyle Changes to book style files labels Nov 20, 2021
Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @jhlegarreta !

@thewtex thewtex merged commit e943f7b into InsightSoftwareConsortium:master Nov 29, 2021
@jhlegarreta jhlegarreta deleted the PrinBackslashMark branch November 29, 2021 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Appendices Issues affecting the Appendices part area:Documentation Issues affecting the Documentation module language:LaTeX Changes to LaTeX code type:BookStyle Changes to book style files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants