public inbox for gcc-bugs@sourceware.org help / color / mirror / Atom feed
* [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation @ 2023-05-25 11:09 saifi.khan at nishan dot io 2023-05-25 13:23 ` [Bug libstdc++/109965] " redi at gcc dot gnu.org ` (4 more replies) 0 siblings, 5 replies; 6+ messages in thread From: saifi.khan at nishan dot io @ 2023-05-25 11:09 UTC (permalink / raw) To: gcc-bugs https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109965 Bug ID: 109965 Summary: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation Product: gcc Version: 14.0 Status: UNCONFIRMED Severity: normal Priority: P3 Component: libstdc++ Assignee: unassigned at gcc dot gnu.org Reporter: saifi.khan at nishan dot io Target Milestone: --- Created attachment 55154 --> https://gcc.gnu.org/bugzilla/attachment.cgi?id=55154&action=edit Tree view as seen by user of documentation and contents under 'Modules'. This relates to doxygen generated 'libstdc++ source documentation' The documentation uses the term 'Modules' on its first page https://softwarehub.sourceforge.io/libstdcxx/api/ and on the said 'Modules' page https://softwarehub.sourceforge.io/libstdcxx/api/modules.html The 'contents' under the 'Modules' tree view are Algorithms Atomics Concurrency Containers Diagnostics Extensions File System I/O Iterators Locales Numerics Random Number Generation Ranges Regular Expressions Strings Technical Specifications Utilities A review of the word 'Modules' here is warranted to avoid confusion with the use of an identical word 'modules' in the context of C++ modules. Perhaps the word 'Modules' may be renamed to 'Categories' as used in the context of an organizing principle. ^ permalink raw reply [flat|nested] 6+ messages in thread
* [Bug libstdc++/109965] rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation 2023-05-25 11:09 [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation saifi.khan at nishan dot io @ 2023-05-25 13:23 ` redi at gcc dot gnu.org 2023-05-25 15:14 ` saifi.khan at nishan dot io ` (3 subsequent siblings) 4 siblings, 0 replies; 6+ messages in thread From: redi at gcc dot gnu.org @ 2023-05-25 13:23 UTC (permalink / raw) To: gcc-bugs https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109965 Jonathan Wakely <redi at gcc dot gnu.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Last reconfirmed| |2023-05-25 Status|UNCONFIRMED |NEW Ever confirmed|0 |1 --- Comment #1 from Jonathan Wakely <redi at gcc dot gnu.org> --- This is Doxygen's terminology, not ours: https://www.doxygen.nl/manual/grouping.html#modules It might be possible to retitle it from "Modules" using a custom layout: https://www.doxygen.nl/manual/customize.html#layout ^ permalink raw reply [flat|nested] 6+ messages in thread
* [Bug libstdc++/109965] rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation 2023-05-25 11:09 [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation saifi.khan at nishan dot io 2023-05-25 13:23 ` [Bug libstdc++/109965] " redi at gcc dot gnu.org @ 2023-05-25 15:14 ` saifi.khan at nishan dot io 2023-05-25 15:23 ` saifi.khan at nishan dot io ` (2 subsequent siblings) 4 siblings, 0 replies; 6+ messages in thread From: saifi.khan at nishan dot io @ 2023-05-25 15:14 UTC (permalink / raw) To: gcc-bugs https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109965 --- Comment #2 from Saifi Khan <saifi.khan at nishan dot io> --- Yes, you are right. Doxygen has 'Modules' hard-coded everywhere in the code as they have used the word as an organizing principle. It starts with enum Kind defined in LayoutNavEntry https://raw.githubusercontent.com/doxygen/doxygen/master/src/layout.h All the string-literals related to usage of word 'Modules' are hard-coded in this file. https://raw.githubusercontent.com/doxygen/doxygen/master/src/translator_en.h Modules Modules List Modules Index There are additional entries with regard to the usage of the term in Fortran which may be skipped. There are multiple translator files on a per-language (human spoken language) basis. Short of re-compiling the doxygen code with string literal changed to "Components" i can't seem to find any other way. ^ permalink raw reply [flat|nested] 6+ messages in thread
* [Bug libstdc++/109965] rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation 2023-05-25 11:09 [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation saifi.khan at nishan dot io 2023-05-25 13:23 ` [Bug libstdc++/109965] " redi at gcc dot gnu.org 2023-05-25 15:14 ` saifi.khan at nishan dot io @ 2023-05-25 15:23 ` saifi.khan at nishan dot io 2023-05-25 15:41 ` redi at gcc dot gnu.org 2023-05-27 4:21 ` saifi.khan at nishan dot io 4 siblings, 0 replies; 6+ messages in thread From: saifi.khan at nishan dot io @ 2023-05-25 15:23 UTC (permalink / raw) To: gcc-bugs https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109965 --- Comment #3 from Saifi Khan <saifi.khan at nishan dot io> --- Trying the 'custom' layout approach that you suggested. The file modified is /opt/gcc/src/libstdc++-v3/doc/doxygen/DoxygenLayout.xml <tab type="modules" visible="yes" title="Categories" intro=""/> ^ permalink raw reply [flat|nested] 6+ messages in thread
* [Bug libstdc++/109965] rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation 2023-05-25 11:09 [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation saifi.khan at nishan dot io ` (2 preceding siblings ...) 2023-05-25 15:23 ` saifi.khan at nishan dot io @ 2023-05-25 15:41 ` redi at gcc dot gnu.org 2023-05-27 4:21 ` saifi.khan at nishan dot io 4 siblings, 0 replies; 6+ messages in thread From: redi at gcc dot gnu.org @ 2023-05-25 15:41 UTC (permalink / raw) To: gcc-bugs https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109965 --- Comment #4 from Jonathan Wakely <redi at gcc dot gnu.org> --- (In reply to Saifi Khan from comment #2) > Short of re-compiling the doxygen code with string literal changed to > "Components" i can't seem to find any other way. Well if nothing else works, we can just use sed on the generated pages. (In reply to Saifi Khan from comment #3) > The file modified is > /opt/gcc/src/libstdc++-v3/doc/doxygen/DoxygenLayout.xml It needs to be in the directory where doxygen is run, or pointed to by the LAYOUT_FILE config in doc/doxygen/user.cfg.in ^ permalink raw reply [flat|nested] 6+ messages in thread
* [Bug libstdc++/109965] rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation 2023-05-25 11:09 [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation saifi.khan at nishan dot io ` (3 preceding siblings ...) 2023-05-25 15:41 ` redi at gcc dot gnu.org @ 2023-05-27 4:21 ` saifi.khan at nishan dot io 4 siblings, 0 replies; 6+ messages in thread From: saifi.khan at nishan dot io @ 2023-05-27 4:21 UTC (permalink / raw) To: gcc-bugs https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109965 --- Comment #5 from Saifi Khan <saifi.khan at nishan dot io> --- raised the issue with doxygen project folks. https://github.com/doxygen/doxygen/issues/10093 There is no direct solution or workaround as per response. ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-05-27 4:21 UTC | newest] Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2023-05-25 11:09 [Bug libstdc++/109965] New: rename 'Modules' to 'Categories' in tree-view of doxygen-generated libstdc++ documentation saifi.khan at nishan dot io 2023-05-25 13:23 ` [Bug libstdc++/109965] " redi at gcc dot gnu.org 2023-05-25 15:14 ` saifi.khan at nishan dot io 2023-05-25 15:23 ` saifi.khan at nishan dot io 2023-05-25 15:41 ` redi at gcc dot gnu.org 2023-05-27 4:21 ` saifi.khan at nishan dot io
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).