[Insight-developers] ITK Doxygen documentation style

[Williams, Norman K]

I actually miss the inheritance diagrams. I know that they're gigantic and
hard to read for some base classes, but they are good when you're looking
for a class to use and you aren't sure what level of specialization you
need to work at.


I like the thing in the current documentation where the diagrams are
viewable if you click on the little triangle.

I'm not 100% sure I like the always-present left hand navigation tree.  it
constrains horizontal space, which can make some pages harder to read, and
since a lot of the tree items have hundreds of children, it's less useful
than it might be.

I rather like the VTK Doxygen pages, with the two level boxy index at the
top.

http://www.vtk.org/doc/nightly/html/index.html

On the other hand I think the top level page could stand to have more
useful information. It's the sort of stuff that should be at www.itk.org
-- if you're looking at the documentation, it's just wasted space that
could potentially link out to more interesting stuff.

On 3/30/11 9:15 AM, "Arnaud GELAS" <arnaud_gelas at hms.harvard.edu> wrote:

>Hi all,
>
>I have recently submitted a patch to gerrit to use a more modern and
>fresher style for the doxygen documentation:
>
>     http://review.source.kitware.com/#change,1269
>
>We have tried to a run doxygen with this patch on a subset of ITK (i.e.
>Modules/Core).
>Note that we have also removed the diagram generation on this
>documentation (for timing purpose).
>
>You can see the resulting documentation here:
>
>     http://www.cs.unc.edu/~cquammen/ITK/html/
>
>
>Here is the current documentation (generated last night):
>
>     http://www.itk.org/Doxygen/html/index.html
>
>
>We would like to know what people think about these two styles, if there
>are any strong opinion on one style versus the other one.
>
>We could discuss and decide during the next TConf which one will be used.
>
>Best,
>Arnaud
>
>_______________________________________________
>Powered by www.kitware.com
>
>Visit other Kitware open-source projects at
>http://www.kitware.com/opensource/opensource.html
>
>Kitware offers ITK Training Courses, for more information visit:
>http://kitware.com/products/protraining.html
>
>Please keep messages on-topic and check the ITK FAQ at:
>http://www.itk.org/Wiki/ITK_FAQ
>
>Follow this link to subscribe/unsubscribe:
>http://www.itk.org/mailman/listinfo/insight-developers



________________________________
Notice: This UI Health Care e-mail (including attachments) is covered by the Electronic Communications Privacy Act, 18 U.S.C. 2510-2521, is confidential and may be legally privileged.  If you are not the intended recipient, you are hereby notified that any retention, dissemination, distribution, or copying of this communication is strictly prohibited.  Please reply to the sender that you have received the message in error, then delete it.  Thank you.
________________________________