<div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Feb 24, 2020 at 6:46 AM Andrew Butterfield <<a href="mailto:Andrew.Butterfield@scss.tcd.ie">Andrew.Butterfield@scss.tcd.ie</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div style="overflow-wrap: break-word;">Hi Joel,<div> any test files we develop (at Lero/TCD) will be generated by python tools, </div><div>so we could include file level Doxygen quite easily, if that is helpful.</div></div></blockquote><div><br></div><div>If we have a desired pattern for test cases, that would be good to define before</div><div>you generate more code. At least the file blocks are good to have.</div><div><br></div><div>For sure, I hate to get even further behind on this. </div><div><br></div><div>On another project, I tried to use Doxygen to capture the tests and defined</div><div>special group named UnitTests and then used @test followed by a paragraph</div><div>and bullet list of all the test cases.</div><div><br></div><div>It seems like Doxygen would have a really good way to do this but I haven't</div><div>found it. :(</div><div><br></div><div>--joel</div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div style="overflow-wrap: break-word;"><div><br></div><div>Regards, Andrew<br><div><br><blockquote type="cite"><div>On 24 Feb 2020, at 12:22, Joel Sherrill <<a href="mailto:joel@rtems.org" target="_blank">joel@rtems.org</a>> wrote:</div><br><div><div dir="auto" style="font-family:Helvetica;font-size:14px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;text-decoration:none"><div><br><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Feb 24, 2020, 6:03 AM Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello Andrew,<br><br>On 24/02/2020 10:48, Andrew Butterfield wrote:<br>> Hi Sebastian,<br>><span> </span><br>> a quick question<br>> - does the Doxygen block requirement also apply to test programs (xxtest/init.c),<br>> either hand-written or model-generated?<br><br>we currently don't use Doxygen in the tests. There is some test<span> </span><br>documentation in the *.doc files of the test suite. I would like to<span> </span><br>improve the test documentation with the test specification items, but<span> </span><br>this is a future topic.<br><br>It is probably a good approach to add some documentation to generated<span> </span><br>files if it is available at a higher level.<br></blockquote></div></div><div dir="auto"><br></div><div dir="auto">It would be good if the tests had at least file level Doxygen. But that's a lot of retrofitting.</div><div dir="auto"><br></div><div dir="auto">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.</div><div dir="auto"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><br>--<span> </span><br>Sebastian Huber, embedded brains GmbH<br><br>Address : Dornierstr. 4, D-82178 Puchheim, Germany<br>Phone   : +49 89 189 47 41-16<br>Fax     : +49 89 189 47 41-09<br>E-Mail  :<span> </span><a href="mailto:sebastian.huber@embedded-brains.de" rel="noreferrer" target="_blank">sebastian.huber@embedded-brains.de</a><br>PGP     : Public key available on request.<br><br>Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.<br>_______________________________________________<br>devel mailing list<br><a href="mailto:devel@rtems.org" rel="noreferrer" target="_blank">devel@rtems.org</a><br><a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a></blockquote></div></div></div></div></blockquote></div><br><div>
<div dir="auto" style="color:rgb(0,0,0);letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;text-decoration:none">--------------------------------------------------------------------<br>Andrew Butterfield     Tel: +353-1-896-2517     Fax: +353-1-677-2204<br>Lero@TCD, Head of Software Foundations & Verification Research Group<br>School of Computer Science and Statistics,<br>Room G.39, O'Reilly Institute, Trinity College, University of Dublin<br>                         <a href="http://www.scss.tcd.ie/Andrew.Butterfield/" target="_blank">http://www.scss.tcd.ie/Andrew.Butterfield/</a><br>--------------------------------------------------------------------</div>
</div>
<br></div></div></blockquote></div></div>