[prev in list] [next in list] [prev in thread] [next in thread]
List: doxygen-users
Subject: Re: [Doxygen-users] Splitting big documentation / Adding doc for
From: "rmp8427 () googlemail ! com" <rmp8427 () googlemail ! com>
Date: 2011-03-21 14:08:58
Message-ID: AANLkTim5Jf7V4_G7RcA0G=xF8AKE_cZP0K+5qif+uFh1 () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
Yee, thanks that hits the second one. But I still got problems with the
first problem. My documentation goes like this:
Foo.php :
class Foo {
/**
* brief sentence
*
* @param $doctor
*/
public function who($doctor) { ... }
}
Another.php shall be :
/**
* \fn Foo::who
*
* Additional information that shall be written with this function.
* In another file because it to long to go within the original file.
*/
So that first the upper docs appear and with that some additional as below.
But doxygen exterminates my additional documentation and it won't be shown
in HTML output. That's how I tried to separate but it didn't work.
How do I separate right?
Thanks in advance!
2011/3/21 J.S. van Bethlehem <j.s.van.bethlehem@astro.rug.nl>
> Splitting documentation in the way you write should be automatically
> handled by Doxygen - you do need to make sure though to use the right
> syntax: it is \fn and not \fc Hopefully that solves that problem.
> For your second question - I don't know PHP at all (definitely not
> OO-PHP), but I'd suggest you to have a look at \memberof, \relates,
> \implements and \extends. One of these will probably do what you want.
>
> Greetsz, Jakob
>
> rmp8427@googlemail.com wrote:
> > Hi there.
> >
> > The qeustions are:
> > 1. How do I split documentation for the same method?
> > 2. How can I add documentation for "undefined" methods?
> >
> > ---
> >
> > I do much documentation for my classes and every method got it's own
> > example. This makes my php-files going bigger and bigger.
> >
> > What I want to do now is to split the documentation into multiple
> > files in a way that has the common docs within the class:
> >
> > class Foo {
> > /**
> > * some doc here
> > */
> > function Bar()
> > }
> >
> > ... and the examples in a external file like this:
> >
> > /**
> > * \fc Foo::Bar
> > *
> > * additional examples and so on
> > *
> > */
> >
> > But how can I merge these docs? When I create the HTML output it only
> > shows the documentation above the method itself.
> >
> > ---
> >
> > And how can I do pages for methods that doesn t exists in the
> > class-file itself? Something like this:
> >
> > class Yee
> > {
> > /**
> > * @missingCommand Yee::NotGivenMethod
> > *
> > * but a doc for it
> > */
> > }
> >
> >
> > greetings
> > ------------------------------------------------------------------------
> >
> >
> ------------------------------------------------------------------------------
> > Colocation vs. Managed Hosting
> > A question and answer guide to determining the best fit
> > for your organization - today and in the future.
> > http://p.sf.net/sfu/internap-sfd2d
> > ------------------------------------------------------------------------
> >
> > _______________________________________________
> > Doxygen-users mailing list
> > Doxygen-users@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
>
>
>
> ------------------------------------------------------------------------------
> Colocation vs. Managed Hosting
> A question and answer guide to determining the best fit
> for your organization - today and in the future.
> http://p.sf.net/sfu/internap-sfd2d
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
[Attachment #5 (text/html)]
Yee, thanks that hits the second one. But I still got problems with the first \
problem. My documentation goes like this:<div><br></div><div><br></div><div>Foo.php \
:</div><div>class Foo {</div><div> /**</div><div> * brief sentence</div>
<div> * </div><div> * @param $doctor</div><div> */</div><div> public \
function who($doctor) { ... }</div><div>}</div><div><br></div><div>Another.php shall \
be :</div><div>/**</div><div> * \fn Foo::who</div><div> *</div>
<div> * Additional information that shall be written with this function.</div><div> \
* In another file because it to long to go within the original file.</div><div> \
*/</div><div><br></div><div>So that first the upper docs appear and with that some \
additional as below. But doxygen exterminates my additional documentation and it \
won't be shown in HTML output. That's how I tried to separate but it \
didn't work.</div>
<div><br></div><div>How do I separate \
right?</div><div><br></div><div><br></div><div>Thanks in advance!</div><div><br><div \
class="gmail_quote">2011/3/21 J.S. van Bethlehem <span dir="ltr"><<a \
href="mailto:j.s.van.bethlehem@astro.rug.nl">j.s.van.bethlehem@astro.rug.nl</a>></span><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc \
solid;padding-left:1ex;">Splitting documentation in the way you write should be \
automatically<br> handled by Doxygen - you do need to make sure though to use the \
right<br>
syntax: it is \fn and not \fc Hopefully that solves that problem.<br>
For your second question - I don't know PHP at all (definitely not<br>
OO-PHP), but I'd suggest you to have a look at \memberof, \relates,<br>
\implements and \extends. One of these will probably do what you want.<br>
<br>
Greetsz, Jakob<br>
<div><div></div><div class="h5"><br>
<a href="mailto:rmp8427@googlemail.com">rmp8427@googlemail.com</a> wrote:<br>
> Hi there.<br>
><br>
> The qeustions are:<br>
> 1. How do I split documentation for the same method?<br>
> 2. How can I add documentation for "undefined" methods?<br>
><br>
> ---<br>
><br>
> I do much documentation for my classes and every method got it's own<br>
> example. This makes my php-files going bigger and bigger.<br>
><br>
> What I want to do now is to split the documentation into multiple<br>
> files in a way that has the common docs within the class:<br>
><br>
> class Foo {<br>
> /**<br>
> * some doc here<br>
> */<br>
> function Bar()<br>
> }<br>
><br>
> ... and the examples in a external file like this:<br>
><br>
> /**<br>
> * \fc Foo::Bar<br>
> *<br>
> * additional examples and so on<br>
> *<br>
> */<br>
><br>
> But how can I merge these docs? When I create the HTML output it only<br>
> shows the documentation above the method itself.<br>
><br>
> ---<br>
><br>
> And how can I do pages for methods that doesn t exists in the<br>
> class-file itself? Something like this:<br>
><br>
> class Yee<br>
> {<br>
> /**<br>
> * @missingCommand Yee::NotGivenMethod<br>
> *<br>
> * but a doc for it<br>
> */<br>
> }<br>
><br>
><br>
> greetings<br>
</div></div>> ------------------------------------------------------------------------<br>
><br>
> ------------------------------------------------------------------------------<br>
> Colocation vs. Managed Hosting<br>
> A question and answer guide to determining the best fit<br>
> for your organization - today and in the future.<br>
> <a href="http://p.sf.net/sfu/internap-sfd2d" \
target="_blank">http://p.sf.net/sfu/internap-sfd2d</a><br> > \
------------------------------------------------------------------------<br> ><br>
> _______________________________________________<br>
> Doxygen-users mailing list<br>
> <a href="mailto:Doxygen-users@lists.sourceforge.net">Doxygen-users@lists.sourceforge.net</a><br>
> <a href="https://lists.sourceforge.net/lists/listinfo/doxygen-users" \
target="_blank">https://lists.sourceforge.net/lists/listinfo/doxygen-users</a><br> \
><br> <br>
<br>
------------------------------------------------------------------------------<br>
Colocation vs. Managed Hosting<br>
A question and answer guide to determining the best fit<br>
for your organization - today and in the future.<br>
<a href="http://p.sf.net/sfu/internap-sfd2d" \
target="_blank">http://p.sf.net/sfu/internap-sfd2d</a><br> \
_______________________________________________<br> Doxygen-users mailing list<br>
<a href="mailto:Doxygen-users@lists.sourceforge.net">Doxygen-users@lists.sourceforge.net</a><br>
<a href="https://lists.sourceforge.net/lists/listinfo/doxygen-users" \
target="_blank">https://lists.sourceforge.net/lists/listinfo/doxygen-users</a><br> \
</blockquote></div><br></div>
------------------------------------------------------------------------------
Colocation vs. Managed Hosting
A question and answer guide to determining the best fit
for your organization - today and in the future.
http://p.sf.net/sfu/internap-sfd2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic