[petsc-dev] description and mansec in PetscHeaderCreate()

[Matthew Knepley]

On Fri, Aug 26, 2011 at 12:32 AM, Jed Brown <jedbrown at mcs.anl.gov> wrote:

> I wanted (a) only one -help output per object and (b) more structured
> options for objects, so I added two fields to _p_PetscObject:
>
> char *description; /* long description of the object */
> char *mansec; /* manual section for more information about the object */
>
> These correspond to two new arguments to PetscHeaderCreate().
>
> Then I made a new function PetscObjectOptionsBegin(PetscObject) that
> handles printing only once (through a flag in _p_PetscObject) and fills out
> the correct description and man sections.
>
> I'm most of the way done with implementing this, but speak up if you think
> it's a bad idea.


Do we really need per object help? Shouldn't this be per class?

   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/20110826/3fbad659/attachment.html>