[vtk-developers] Information Key documentation

[Berk Geveci]

+1

On Sat, Mar 24, 2012 at 11:35 PM, Cory Quammen <cquammen at cs.unc.edu> wrote:

> +1
>
> On Sat, Mar 24, 2012 at 9:22 PM, Marcus D. Hanwell
> <marcus.hanwell at kitware.com> wrote:
> > That does sound like the ideal way to do this. +1 from me.
> >
> > On Sat, Mar 24, 2012 at 10:19 AM, Bill Lorensen <bill.lorensen at gmail.com>
> wrote:
> >> Sounds like the right spot to do it.
> >>
> >> Thanks,
> >>
> >> Bill
> >>
> >> On Sat, Mar 24, 2012 at 7:14 AM, Utkarsh Ayachit
> >> <utkarsh.ayachit at kitware.com> wrote:
> >>> I'd recommend that we document the keys using doxygen's "group"
> >>> support (@defgroup, @ingroup). That enables doxygen to generate a
> >>> "module" page for the entries in a particular group while the entries
> >>> themselves can be defined in different files. We use that in ParaView:
> >>> http://www.paraview.org/ParaView3/Doc/Nightly/html/modules.html, for
> example.
> >>>
> >>> This will avoid the need to document the entries at one central
> >>> location in the source, while still providing a central access page
> >>> for the generated documentation.
> >>>
> >>> We can even create different groups for the keys based on their role
> >>> e.g. keys used in pipeline requests, keys used for meta-data, etc.
> >>>
> >>> Utkarsh
> >>>
> >>> On Fri, Mar 23, 2012 at 2:29 PM, Bill Lorensen <
> bill.lorensen at gmail.com> wrote:
> >>>> Folks,
> >>>>
> >>>> I just did a quick grep of vtk and uncovered 180 unique information
> >>>> keys defined in 27 different classes. Is there a central location that
> >>>> documents these keys?  Some of the keys are documented in the header
> >>>> file for the class.
> >>>>
> >>>> For example, Algorithm defines these keys:
> >>>> Algorithm:  IntegerKey INPUT_IS_OPTIONAL
> >>>> Algorithm:  IntegerKey INPUT_IS_REPEATABLE
> >>>> Algorithm:  InformationVectorKey INPUT_REQUIRED_FIELDS
> >>>> Algorithm:  StringVectorKey INPUT_REQUIRED_DATA_TYPE
> >>>> Algorithm:  InformationVectorKey INPUT_ARRAYS_TO_PROCESS
> >>>> Algorithm:  IntegerKey INPUT_PORT
> >>>> Algorithm:  IntegerKey INPUT_CONNECTION
> >>>> Algorithm:  IntegerKey PRESERVES_DATASET
> >>>> Algorithm:  IntegerKey PRESERVES_GEOMETRY
> >>>> Algorithm:  IntegerKey PRESERVES_BOUNDS
> >>>> Algorithm:  IntegerKey PRESERVES_TOPOLOGY
> >>>> Algorithm:  IntegerKey PRESERVES_ATTRIBUTES
> >>>> Algorithm:  IntegerKey PRESERVES_RANGES
> >>>> Algorithm:  IntegerKey MANAGES_METAINFORMATION
> >>>>
> >>>> Bill
> >>>> _______________________________________________
> >>>> Powered by www.kitware.com
> >>>>
> >>>> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
> >>>>
> >>>> Follow this link to subscribe/unsubscribe:
> >>>> http://www.vtk.org/mailman/listinfo/vtk-developers
> >>>>
> >>
> >>
> >>
> >> --
> >> Unpaid intern in BillsBasement at noware dot com
> >> _______________________________________________
> >> Powered by www.kitware.com
> >>
> >> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
> >>
> >> Follow this link to subscribe/unsubscribe:
> >> http://www.vtk.org/mailman/listinfo/vtk-developers
> >>
> > _______________________________________________
> > Powered by www.kitware.com
> >
> > Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
> >
> > Follow this link to subscribe/unsubscribe:
> > http://www.vtk.org/mailman/listinfo/vtk-developers
> >
>
>
>
> --
> Cory Quammen
> Research Associate
> Department of Computer Science
> The University of North Carolina at Chapel Hill
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/vtk-developers/attachments/20120329/45db5393/attachment.html>