[petsc-dev] Documentation comment support

[Jed Brown]

On Mon, Jan 7, 2013 at 5:17 PM, Barry Smith <bsmith at mcs.anl.gov> wrote:

> On Jan 7, 2013, at 4:56 PM, Jed Brown <jedbrown at mcs.anl.gov> wrote:
>
> > Karl, do you know a way to make man pages automatically link to use
> cases in .../examples/tutorials/? (The other direction is fine and dandy,
> but the reverse links are extremely useful.)
>
>   Jed,
>
>    Do you mean like the Examples section in
> http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMDACreate3d.html?
> but linking directly to the line that uses the function instead of just to
> the file?


Yeah, but I haven't even seen Doxygen link to the file. It does forward
links (from the example to the man page), but I haven't seen the other
direction and didn't notice that capability in the documentation, but it
seems like a weird thing to not implement (except that it's sort of hard
--- requires an extra level of indexing).
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20130107/2c68fad4/attachment.html>