On Mon, Feb 24, 2020 at 6:46 AM Andrew Butterfield < andrew.butterfi...@scss.tcd.ie> wrote:
> Hi Joel, > any test files we develop (at Lero/TCD) will be generated by python > tools, > so we could include file level Doxygen quite easily, if that is helpful. > If we have a desired pattern for test cases, that would be good to define before you generate more code. At least the file blocks are good to have. For sure, I hate to get even further behind on this. On another project, I tried to use Doxygen to capture the tests and defined special group named UnitTests and then used @test followed by a paragraph and bullet list of all the test cases. It seems like Doxygen would have a really good way to do this but I haven't found it. :( --joel > > Regards, Andrew > > On 24 Feb 2020, at 12:22, Joel Sherrill <j...@rtems.org> wrote: > > > > On Mon, Feb 24, 2020, 6:03 AM Sebastian Huber < > sebastian.hu...@embedded-brains.de> wrote: > >> Hello Andrew, >> >> On 24/02/2020 10:48, Andrew Butterfield wrote: >> > Hi Sebastian, >> > >> > a quick question >> > - does the Doxygen block requirement also apply to test programs >> (xxtest/init.c), >> > either hand-written or model-generated? >> >> we currently don't use Doxygen in the tests. There is some test >> documentation in the *.doc files of the test suite. I would like to >> improve the test documentation with the test specification items, but >> this is a future topic. >> >> It is probably a good approach to add some documentation to generated >> files if it is available at a higher level. >> > > It would be good if the tests had at least file level Doxygen. But that's > a lot of retrofitting. > > Andrew may not realise that Doxygen is newer than RTEMS and that all > Doxygen comments are later additions or conversions of the previous comment > format. > >> >> -- >> Sebastian Huber, embedded brains GmbH >> >> Address : Dornierstr. 4, D-82178 Puchheim, Germany >> Phone : +49 89 189 47 41-16 >> Fax : +49 89 189 47 41-09 >> E-Mail : sebastian.hu...@embedded-brains.de >> PGP : Public key available on request. >> >> Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG. >> _______________________________________________ >> devel mailing list >> devel@rtems.org >> http://lists.rtems.org/mailman/listinfo/devel > > > -------------------------------------------------------------------- > Andrew Butterfield Tel: +353-1-896-2517 Fax: +353-1-677-2204 > Lero@TCD, Head of Software Foundations & Verification Research Group > School of Computer Science and Statistics, > Room G.39, O'Reilly Institute, Trinity College, University of Dublin > http://www.scss.tcd.ie/Andrew.Butterfield/ > -------------------------------------------------------------------- > >
_______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel