[petsc-dev] Documentation comment support

Jed Brown jedbrown at mcs.anl.gov
Wed Jan 9 09:04:03 CST 2013


I think it's a matter of perceived effort. Specifically all the formatting
and web organization (and all the cross-references that they handle
automatically). There are Python libraries for some of this stuff so in the
end, it might not be offering that much.


On Wed, Jan 9, 2013 at 12:06 AM, Barry Smith <bsmith at mcs.anl.gov> wrote:

>
>   If we really need to write a hierarchy of shaky scripts to use oxygen,
> then why not just write a hierarchy of shaky scripts (like we do now) and
> not use doxygen?
>
>    Doxygen is an ugly dependency unless it truly delivers some fantastic
> feature we cannot reproduce I think it should be avoided. So what is that
> fantastic feature?
>
>
>    Barry
>
>   Yes sowing is an ugly dependency but at least it is OUR dependency. And
> yes I have no problem with Matt rewriting all of sowing in python :-)
>
>
>
>
> On Jan 8, 2013, at 9:32 PM, Jed Brown <jedbrown at mcs.anl.gov> wrote:
>
> > On Tue, Jan 8, 2013 at 8:45 PM, Karl Rupp <rupp at mcs.anl.gov> wrote:
> > I was thinking of using an input filter, perhaps after creating an index.
> >
> > http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_input_filter
> >
> > If a single filter is sufficient for all files, this is indeed the
> better option. Thanks.
> >
> > We get the file name in argv[1] so it can use the path to do different
> things. For example, examples/tests/ are treated differently from
> examples/tutorials/, which are different from library code.
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20130109/4007f9f4/attachment.html>


More information about the petsc-dev mailing list