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.

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

Manual for lists is no longer accessible (Origin: bugzilla #679626) #4788

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity minor in component documentation for ---
Reported in version unspecified on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2012-07-09 12:08:51 +0000, Carl R. Werth wrote:

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.

On 2012-07-09 18:57:32 +0000, Dimitri van Heesch wrote:

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).

On 2012-07-12 15:41:57 +0000, Dimitri van Heesch wrote:

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.

On 2012-11-19 09:25:48 +0000, Carl R. Werth wrote:

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").

On 2013-01-27 13:16:42 +0000, albert wrote:

Created attachment 234524
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.

On 2013-02-23 10:05:56 +0000, Dimitri van Heesch wrote:

Thanks, I'll include the patch in the next subversion update.

On 2013-05-19 12:36:30 +0000, Dimitri van Heesch wrote:

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.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment