After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 679626 - Manual for lists is no longer accessible
Manual for lists is no longer accessible
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: documentation
unspecified
Other All
: Normal minor
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2012-07-09 12:08 UTC by Carl R. Werth
Modified: 2013-05-19 12:36 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
PATCH: corrects links in documentation regarding next and index (12.24 KB, patch)
2013-01-27 13:16 UTC, albert
none Details | Review

Description Carl R. Werth 2012-07-09 12:08:51 UTC
Hello!

In the manual to doxygen there was a page for lists (http://www.stack.nl/~dimitri/doxygen/lists.html).
This page is no longer accessible since there is no entry for the lists in the main page (http://www.stack.nl/~dimitri/doxygen/manual.html).

There are only two hard to find links to the "next section" before the header "Comment blocks in VHDL" and before the header "Anatomy of a comment block" inside the page "Documenting the code" (http://www.stack.nl/~dimitri/doxygen/docblocks.html).

It is the same within a downloaded and installed manual.


By the way:
1. At the end of the page "Markdown support" (http://www.stack.nl/~dimitri/doxygen/markdown.html) there is no "Go to the next section or return to the index", like on the other pages.

2. At the end of the page "Lists" (http://www.stack.nl/~dimitri/doxygen/lists.html) there is a "Go to the next section or return to the index", which links to "Grouping" as next section. So "Markdown support" is bypassed by the chain of "next sections".

3. At the page "Documenting the code" there should be "Go to the next section or return to the index" at the *end* of the page (after "Anatomy of a comment block"), not somewhere inside the page.

4. There should be an entry for the "Lists" in the index "Doxygen Manual" (http://www.stack.nl/~dimitri/doxygen/manual.html)

5. In the internet the link to the index in "Go to the next section or return to the index" points to the start page of doxygen (http://www.stack.nl/~dimitri/doxygen/index.html) instead to the index, which would be http://www.stack.nl/~dimitri/doxygen/manual.html in the internet.
In the downloaded and installed manual, this linking is correct, because there the index.html is actually the index of the manual. On the internet the index.html is the main web-page of doxygen as a whole.

Greetings from Bavaria (Germany)
    Carl R.
Comment 1 Dimitri van Heesch 2012-07-09 18:57:32 UTC
Confirmed. Should be fixed in the next subversion update (except for the online index.html v.s. manual.html link which is a bit harder to fix).
Comment 2 Dimitri van Heesch 2012-07-12 15:41:57 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1.2. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.
Comment 3 Carl R. Werth 2012-11-19 09:25:48 UTC
Due to the new sequence of pages ("Documenting the code", "Markdown support", "Lists") the "next section" links in "Documenting the code" should point to "Markdown support".
But before the header "Comment blocks in VHDL" and before the header "Anatomy of a comment block" inside the page "Documenting the code" the links are pointing to "Lists" (the link at the end of the page is correct and points to "Markdown support").
Comment 4 albert 2013-01-27 13:16:42 UTC
Created attachment 234524 [details] [review]
PATCH: corrects links in documentation regarding next and index

This patch corrects the links mentioned in this bug and adds some new links as well, making everything more consistent (I think).

Each "main section" (i.e. sections mentioned on the first level of the HTML index) points to the next main section and to the index, with the exception of the first main  section that only points to the next main section and the last main section that only points to the index.
Comment 5 Dimitri van Heesch 2013-02-23 10:05:56 UTC
Thanks, I'll include the patch in the next subversion update.
Comment 6 Dimitri van Heesch 2013-05-19 12:36:30 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.4. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.