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

Major non-content documentation fixes. #773

Merged
merged 1 commit into from
Sep 21, 2023
Merged

Major non-content documentation fixes. #773

merged 1 commit into from
Sep 21, 2023

Conversation

MarkCallow
Copy link
Collaborator

  • Fix inter-class and intra-class cross-reference issues that appeared with Doxygen 1.9.7 caused partially by the presence of the same-named ktxTexture macro. Fixed by changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
  • Fix intra-class ktxTexture references broken due to presence of the same-named ktxTexture macro. Fixed by using fully qualified "class" names.
  • Fix many, but by no means all, of the remaining references broken by Doxygen 1.9.6's requirement for fully qualified "class" names for inter-class references.
  • Move methods incorrectly labelled as belonging to ktxTexture to their correct ktxTexture1 "class".
  • Restore Topics item to Doxygen navindex for access to the *Loader, Reader and Writer groups.
  • Remove confusions caused by use of @copydetails across classes.
  • Document the ktxTexture macro.

@MarkCallow
Major non-content documentation fixes.
0e8ba2d 
- Fix inter-class and intra-class cross-reference issues
  that appeared with Doxygen 1.9.7 caused partially by the
  presence of the same-named ktxTexture macro. Fixed by
  changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
- Fix intra-class ktxTexture references broken due to presence
  of the same-named ktxTexture macro. Fixed by using fully
  qualified "class" names.
- Fix many, but by no means all, of the remaining references
  broken by Doxygen 1.9.6's requirement for fully qualified
  "class" names for inter-class references.
- Move methods incorrectly labelled as belonging to ktxTexture
  to their correct ktxTexture1 "class".
- Restore Topics item to Doxygen navindex for access to the
  *Loader, Reader and Writer groups.
- Remove confusions caused by use of @copydetails across classes.
- Document the ktxTexture macro.
@MarkCallow MarkCallow merged commit e6a6a3b into main Sep 21, 2023
15 checks passed
@MarkCallow MarkCallow deleted the doc-fixes branch September 21, 2023 23:48
KaperD pushed a commit to KaperD/KTX-Software that referenced this pull request Feb 21, 2024
@MarkCallow
Major non-content documentation fixes. (KhronosGroup#773)
b05e976 
- Fix inter-class and intra-class cross-reference issues
  that appeared with Doxygen 1.9.7 caused partially by the
  presence of the same-named ktxTexture macro. Fixed by
  changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
- Fix intra-class ktxTexture references broken due to presence
  of the same-named ktxTexture macro. Fixed by using fully
  qualified "class" names.
- Fix many, but by no means all, of the remaining references
  broken by Doxygen 1.9.6's requirement for fully qualified
  "class" names for inter-class references.
- Move methods incorrectly labelled as belonging to ktxTexture
  to their correct ktxTexture1 "class".
- Restore Topics item to Doxygen navindex for access to the
  *Loader, Reader and Writer groups.
- Remove confusions caused by use of @copydetails across classes.
- Document the ktxTexture macro.
KaperD pushed a commit to KaperD/KTX-Software that referenced this pull request Feb 22, 2024
@MarkCallow
Major non-content documentation fixes. (KhronosGroup#773)
83bd8b5 
- Fix inter-class and intra-class cross-reference issues
  that appeared with Doxygen 1.9.7 caused partially by the
  presence of the same-named ktxTexture macro. Fixed by
  changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
- Fix intra-class ktxTexture references broken due to presence
  of the same-named ktxTexture macro. Fixed by using fully
  qualified "class" names.
- Fix many, but by no means all, of the remaining references
  broken by Doxygen 1.9.6's requirement for fully qualified
  "class" names for inter-class references.
- Move methods incorrectly labelled as belonging to ktxTexture
  to their correct ktxTexture1 "class".
- Restore Topics item to Doxygen navindex for access to the
  *Loader, Reader and Writer groups.
- Remove confusions caused by use of @copydetails across classes.
- Document the ktxTexture macro.
KaperD pushed a commit to KaperD/KTX-Software that referenced this pull request Feb 22, 2024
@MarkCallow
Major non-content documentation fixes. (KhronosGroup#773)
90a7781 
- Fix inter-class and intra-class cross-reference issues
  that appeared with Doxygen 1.9.7 caused partially by the
  presence of the same-named ktxTexture macro. Fixed by
  changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
- Fix intra-class ktxTexture references broken due to presence
  of the same-named ktxTexture macro. Fixed by using fully
  qualified "class" names.
- Fix many, but by no means all, of the remaining references
  broken by Doxygen 1.9.6's requirement for fully qualified
  "class" names for inter-class references.
- Move methods incorrectly labelled as belonging to ktxTexture
  to their correct ktxTexture1 "class".
- Restore Topics item to Doxygen navindex for access to the
  *Loader, Reader and Writer groups.
- Remove confusions caused by use of @copydetails across classes.
- Document the ktxTexture macro.
KaperD pushed a commit to KaperD/KTX-Software that referenced this pull request Feb 22, 2024
@MarkCallow
Major non-content documentation fixes. (KhronosGroup#773)
a6e967f 
- Fix inter-class and intra-class cross-reference issues
  that appeared with Doxygen 1.9.7 caused partially by the
  presence of the same-named ktxTexture macro. Fixed by
  changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
- Fix intra-class ktxTexture references broken due to presence
  of the same-named ktxTexture macro. Fixed by using fully
  qualified "class" names.
- Fix many, but by no means all, of the remaining references
  broken by Doxygen 1.9.6's requirement for fully qualified
  "class" names for inter-class references.
- Move methods incorrectly labelled as belonging to ktxTexture
  to their correct ktxTexture1 "class".
- Restore Topics item to Doxygen navindex for access to the
  *Loader, Reader and Writer groups.
- Remove confusions caused by use of @copydetails across classes.
- Document the ktxTexture macro.
KaperD pushed a commit to KaperD/KTX-Software that referenced this pull request Feb 22, 2024
@MarkCallow
Major non-content documentation fixes. (KhronosGroup#773)
c966fae 
- Fix inter-class and intra-class cross-reference issues
  that appeared with Doxygen 1.9.7 caused partially by the
  presence of the same-named ktxTexture macro. Fixed by
  changing TYPEDEF_HIDES_STRUCT from YES to NO in config.
- Fix intra-class ktxTexture references broken due to presence
  of the same-named ktxTexture macro. Fixed by using fully
  qualified "class" names.
- Fix many, but by no means all, of the remaining references
  broken by Doxygen 1.9.6's requirement for fully qualified
  "class" names for inter-class references.
- Move methods incorrectly labelled as belonging to ktxTexture
  to their correct ktxTexture1 "class".
- Restore Topics item to Doxygen navindex for access to the
  *Loader, Reader and Writer groups.
- Remove confusions caused by use of @copydetails across classes.
- Document the ktxTexture macro.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@MarkCallow