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.

Sign up for GitHub

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

Jump to bottom

Documentation double dashes (--) turn into n-dash (–) #766

Closed
nighthawk469 opened this issue Sep 12, 2023 · 3 comments · Fixed by #767
Closed

Documentation double dashes (--) turn into n-dash (–) #766

nighthawk469 opened this issue Sep 12, 2023 · 3 comments · Fixed by #767

Comments

@nighthawk469
Copy link

nighthawk469 commented Sep 12, 2023 •
edited
Loading

In this doc, toktx options like --cubemap are incorrectly formatted like –cubemap
https://github.khronos.org/KTX-Software/ktxtools/toktx.html

Source
https://github.com/KhronosGroup/KTX-Software/blob/main/tools/toktx/toktx.cc

I think this could be worked around using

\--
This command writes two dashes (--) to the output. This allows writing two consecutive dashes to the output instead of one n-dash character (–).
https://www.doxygen.nl/manual/commands.html

Related
fish-shell/fish-shell#1557
MarkCallow added a commit that referenced this issue Sep 13, 2023
@MarkCallow
Use \-- in doc. to get -- not n-dash in output.
9e9c74c 
Fixes #766.
@MarkCallow MarkCallow mentioned this issue Sep 13, 2023
Merged
@MarkCallow
Copy link
Collaborator

Thanks for the report. It affects documentation for all the tools not just toktx.

MarkCallow added a commit that referenced this issue Sep 13, 2023
@MarkCallow
Use \-- in doc. to get -- not n-dash in output. (#767)
7247900 
Fixes #766.
@nighthawk469
Copy link
Author

I'm not sure if the doxygen docs have been regenerated yet, but I'm not seeing a change. It's possible the fix I suggested is not working.

https://github.khronos.org/KTX-Software/ktxtools/toktx.html

@MarkCallow
Copy link
Collaborator

The docs are only generated and published when a release is tagged and built. I have verified the fix in my local work area. I have a couple of other fixes I want to make before spinning a release.

KaperD pushed a commit to KaperD/KTX-Software that referenced this issue Feb 21, 2024
@MarkCallow
Use \-- in doc. to get -- not n-dash in output. (KhronosGroup#767)
c2c7246 
Fixes KhronosGroup#766.
KaperD pushed a commit to KaperD/KTX-Software that referenced this issue Feb 22, 2024
@MarkCallow
Use \-- in doc. to get -- not n-dash in output. (KhronosGroup#767)
efa9dd3 
Fixes KhronosGroup#766.
KaperD pushed a commit to KaperD/KTX-Software that referenced this issue Feb 22, 2024
@MarkCallow
Use \-- in doc. to get -- not n-dash in output. (KhronosGroup#767)
348884d 
Fixes KhronosGroup#766.
KaperD pushed a commit to KaperD/KTX-Software that referenced this issue Feb 22, 2024
@MarkCallow
Use \-- in doc. to get -- not n-dash in output. (KhronosGroup#767)
aeb97c8 
Fixes KhronosGroup#766.
KaperD pushed a commit to KaperD/KTX-Software that referenced this issue Feb 22, 2024
@MarkCallow
Use \-- in doc. to get -- not n-dash in output. (KhronosGroup#767)
422368d 
Fixes KhronosGroup#766.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use \-- in doc. to get -- not n-dash in output. KhronosGroup/KTX-Software
2 participants
@MarkCallow @nighthawk469