<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body dir="auto"><div></div><div style="direction: inherit;">But an install tree will have doxygen's output in it.</div><div><div style="direction: inherit;"><br></div><div style="direction: inherit;"> David</div><div style="direction: inherit;"><br></div>On Sep 17, 2016, at 22:37, David Cole <<a href="mailto:DLRdave@aol.com">DLRdave@aol.com</a>> wrote:<br><br></div><blockquote type="cite"><div><meta http-equiv="content-type" content="text/html; charset=utf-8"><div>Another argument for keeping all documentation in the header files is so it's available in an install-tree-only situation. Some people use VTK without the source tree around, and having the docs built into the header files is quite nice in that scenario. If it were in the cxx files, it wouldn't be available to such users.<br><br><br>David</div><div><br></div><div><br>On Sep 17, 2016, at 6:47 PM, David Thompson <<a href="mailto:david.thompson@kitware.com">david.thompson@kitware.com</a>> wrote:<br><br></div><blockquote type="cite"><div><meta http-equiv="content-type" content="text/html; charset=utf-8"><div></div><div style="direction: inherit;">Hi Andrew,</div><div><br>...</div><blockquote type="cite"><div><div dir="ltr"><div>For what it is worth, I also believe that documentation should be with the declaration simply because the header files are the ones people tend to first look at not the definition. This is what VTK currently does. ...</div></div></div></blockquote><div style="direction: inherit;"><br></div><div style="direction: inherit;">I think that moving method (not class) documentation out of the headers makes the headers much more terse and legible. For the vast majority of classes, the method names themselves are enough documentation. In cases where method names are not enough, it is nice to have the implementation nearby. Methods with inline or macro-generated implementations would still have documentation in the header, as would enums.</div><div style="direction: inherit;"><br></div><div style="direction: inherit;"> David</div></div></blockquote><blockquote type="cite"><div><span>_______________________________________________</span><br><span>Powered by <a href="http://www.kitware.com">www.kitware.com</a></span><br><span></span><br><span>Visit other Kitware open-source projects at <a href="http://www.kitware.com/opensource/opensource.html">http://www.kitware.com/opensource/opensource.html</a></span><br><span></span><br><span>Please keep messages on-topic and check the VTK FAQ at: <a href="http://www.vtk.org/Wiki/VTK_FAQ">http://www.vtk.org/Wiki/VTK_FAQ</a></span><br><span></span><br><span>Search the list archives at: <a href="http://markmail.org/search/?q=vtkusers">http://markmail.org/search/?q=vtkusers</a></span><br><span></span><br><span>Follow this link to subscribe/unsubscribe:</span><br><span><a href="http://public.kitware.com/mailman/listinfo/vtkusers">http://public.kitware.com/mailman/listinfo/vtkusers</a></span><br></div></blockquote></div></blockquote></body></html>