[petsc-dev] Documentation comment support

[Matthew Knepley]

On Tue, Jan 8, 2013 at 9:34 PM, Jed Brown <jedbrown at mcs.anl.gov> wrote:

> On Tue, 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<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.
>>
>
> To improve Fortran stubs, I've considered going so far as to get a proper
> parse, e.g., with pycparser.
>
> https://bitbucket.org/eliben/pycparser
>
> I don't think you need anything this sophisticated to augment the
> documentation, but I don't think there is any loss of generality from using
> an input filter.
>

Those wimps just call cpp instead of writing the preprocessor in Python too
(I did this). That means
you cannot regenerate properly.

   Matt

-- 
What most experimenters take for granted before they begin their
experiments is infinitely more interesting than any results to which their
experiments lead.
-- Norbert Wiener
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20130108/099dda3b/attachment.html>