Actually, the list of doxygen commands should do for me. While I am sort of used to writing C++ documentation, I haven't used it for User Manuals, or plain English. So, I was only after a few pointers.
A list of check points or reminders of what might be useful to include should probably help most people. Matt On 13 Sep 2011, at 12:28, Goch, Caspar Jonas wrote: > Hi Matt, > > aside from the obvious ( http://www.stack.nl/~dimitri/doxygen/commands.html ) > we do not yet have a real formatting guide. Mostly you can take a look at the > documentation for other bundles > (http://docs.mitk.org/nightly-qt4/ModuleListPage.html ) or the general MITK > Documentation (http://docs.mitk.org/nightly-qt4/pages.html ) and decide which > style would work for you and see how it is done in the corresponding .dox > file. > > Having said that, I opened a bug a couple of days ago concerning the lack of > such a guide ( http://bugs.mitk.org/show_bug.cgi?id=9367 ) and will probably > work on that tomorrow, so you are very welcome to leave a comment on what > would be of interest to you. Any input on what external MITK users need in > such a guide is very much appreciated. > > Best, > Caspar > > -----Ursprüngliche Nachricht----- > Von: Clarkson, Matt [mailto:[email protected]] > Gesendet: Dienstag, 13. September 2011 11:03 > An: Miklos Espak > Cc: mitk-users > Betreff: Re: [mitk-users] MitkExtQtHelpCollection error > > Yes, I thought about that too. > > One simple final (on this subject) question from me. Does anyone have a handy > formatting guide for the allowable syntax for the help pages? Style is > all-important obviously. > Thanks > > Matt > > > On 13 Sep 2011, at 09:58, Miklos Espak wrote: > >> Hi Sascha, >> >> we had a discussion about the MITK_REVISION_ID and the help >> collection, recently. I had the same problem as Matt, so I removed the >> reference to the MITK revision in my little contribution to the >> project template (http://github.com/cim-unito/MITK-ProjectTemplate). >> You said that it is not needed anymore. >> >> However, according to Matt's e-mail, setting the revision id using >> that function is another possible solution. >> >> Best, >> Miklos >> > > > > ------------------------------------------------------------------------------ > BlackBerry® DevCon Americas, Oct. 18-20, San Francisco, CA > Learn about the latest advances in developing for the > BlackBerry® mobile platform with sessions, labs & more. > See new tools and technologies. Register for BlackBerry® DevCon today! > http://p.sf.net/sfu/rim-devcon-copy1 > _______________________________________________ > mitk-users mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/mitk-users > ------------------------------------------------------------------------------ BlackBerry® DevCon Americas, Oct. 18-20, San Francisco, CA Learn about the latest advances in developing for the BlackBerry® mobile platform with sessions, labs & more. See new tools and technologies. Register for BlackBerry® DevCon today! http://p.sf.net/sfu/rim-devcon-copy1 _______________________________________________ mitk-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/mitk-users
