doxygen-users

[Doxygen-users] The details of a function template are not accessible in generated documentation

[didje <dia...@pd...>]

Doxygen 1.8.7

I am generating documentation for the following file (don't ask me what the
file is for, I don't know, I'm not the programmer..):

/*!
 * \file TestHelpMe.h
 * \brief Here is the brief text.
 * \details Here are the details
 */

namespace NAMESPACE_X {


/*! \brief Here is the brief function text
 * \details Here is the detailed function text.
 *
 * \param it some text.
 */
template<int i>
void doSomeStuff (i it) {
cout << "Hello" << endl;  
}

}

Doxygen generates documentation as in the image attached

<http://doxygen.10944.n7.nabble.com/file/n7196/TestHelpMe.png> 

However, when I click the "More" link for the "doSomeStuff" function, it
does not expand to show the text indicated by the \details tab, or send me
down the page to some other expanded version of this documentation.

Why is the "More" link not operational and is there any way for me to make
it so ?

Thanks,




--
View this message in context: http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] The details of a function template are not accessible in generated documentation

[Albert <alb...@gm...>]

Problem looks to be related to not documented namespace. When documenting
the namespace the links work.
I think the 'More...'  should not be present, probably best is to file a
bug report in bugzilla.

Albert

On Thu, May 28, 2015 at 12:07 PM, didje <dia...@pd...> wrote:

> Doxygen 1.8.7
>
> I am generating documentation for the following file (don't ask me what the
> file is for, I don't know, I'm not the programmer..):
>
> /*!
>  * \file TestHelpMe.h
>  * \brief Here is the brief text.
>  * \details Here are the details
>  */
>
> namespace NAMESPACE_X {
>
>
> /*! \brief Here is the brief function text
>  * \details Here is the detailed function text.
>  *
>  * \param it some text.
>  */
> template<int i>
> void doSomeStuff (i it) {
> cout << "Hello" << endl;
> }
>
> }
>
> Doxygen generates documentation as in the image attached
>
> <http://doxygen.10944.n7.nabble.com/file/n7196/TestHelpMe.png>
>
> However, when I click the "More" link for the "doSomeStuff" function, it
> does not expand to show the text indicated by the \details tab, or send me
> down the page to some other expanded version of this documentation.
>
> Why is the "More" link not operational and is there any way for me to make
> it so ?
>
> Thanks,
>
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] The details of a function template are not accessible in generated documentation

[didje <dia...@pd...>]

Hi Albert,
Did you try to generate the documentation with the file I supplied above and
did it work for you after you documented the namespace?
Because, even when I document the namespace, I have the same problem.
I have submitted the issue on bugzilla.
Diarmuid



--
View this message in context: http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196p7198.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] The details of a function template are not accessible in generated documentation

[Albert <alb...@gm...>]

H Diarmuid,

Sorry for the slow response.

When I put the lines:
/** Docu namespace
*/

above the namespace line I get the namespace documentation, but you are
right the "More" is still not working (Well actually it is working, but
pointing to itself instead of pointing to the documentation in the
namespace).

Actual question might even be should the function be documented on files
page of TestHelpMe.h or should it only be documented on the namespace page.

Albert


On Mon, Jun 1, 2015 at 10:46 AM, didje <dia...@pd...> wrote:

> Hi Albert,
> Did you try to generate the documentation with the file I supplied above
> and
> did it work for you after you documented the namespace?
> Because, even when I document the namespace, I have the same problem.
> I have submitted the issue on bugzilla.
> Diarmuid
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/The-details-of-a-function-template-are-not-accessible-in-generated-documentation-tp7196p7198.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>