XML Commands: seealso

[paulushub]

The seealso tag is not completely supported in Doxygen, and it seems it is not fixed in Doxypress. Consider the following:

<seealso href="https://docs.microsoft.com/en-us/windows/win32/api/windef/ns-windef-size">SIZE</seealso>

The attribute href is a well-known extension used in .NET for explicit URL, but this does not work.

<seealso cref="https://docs.microsoft.com/en-us/windows/win32/api/windef/ns-windef-size">SIZE</seealso>

For this, there is See also section generated with the hyperlink text, but it is not hyperlinked and the SIZE is displayed somewhere below.

[bgeller]

To be clear, the \sa command in DoxyPress is not broken and does exactly what it was intended to do.

It appears you are requesting a change to the </seealso> XML tag . Please show a small example of (A) what output you see and (B) what you expect.

Thanks.

[paulushub]

@bgeller Thanks for the response, and thanks for the work on the Doxypress.

Not tested \sa but <see cref="...">Link Text</see> or <see cref="..."/> works as expected.
However, <seealso cref/href="..."></seealso> is not as expected. Unlike the <see/> or \sa, it is expected to be displayed after the remarks; providing links to internal resources with code reference attribute cref, or external resources with the hyperlink attribute, href.

<seealso href="https://docs.microsoft.com/en-us/windows/win32/api/windef/ns-windef-size">SIZE</seealso>

is expected to work like the html <a/> tag

<a href="https://docs.microsoft.com/en-us/windows/win32/api/windef/ns-windef-size">SIZE</a> 

However, the Doxypress output does not generate a hyperlink, the link and the text are displayed on separate lines.

[bgeller]

Thanks for the extra information. We will review this issue with DoxyPress and figure out why it is displaying on multiple lines.

Please let us know if you find other inconsistencies. Pull requests are also welcome.

Barbara

[paulushub]

@bgeller Thanks for the response.

Please let us know if you find other inconsistencies. Pull requests are also welcome.

There are some few others; some of the links in the left navigation pane not working (page not found), Doxygen does not generate link for those "folder" items that are failing.
The LaTeX command is not set in the make.bat file (even if you check the Use PDF LaTeX option), unless you explicitly set
the LaTeX Command Name option to say, pdflatex.

On a different note, I found the Building Settings / Dot naming to be a bit confusing, since the top options of the Part 1 are really not on Dot diagrams. Doxygen used Diagrams for this.
Also, the default font settings for the LaTeX/PDF is not really suitable for programming documentations (compare it with the Doxygen output).