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