From 3ed675ea602b97156cb507050b4b182033ba2e20 Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Thu, 9 Aug 2012 16:01:25 +0200 Subject: [rt25901_atf] Final Doxygen clean-ups. --- doc/devel/atf.dox | 18 +++++++----------- doc/devel/mainpage.dox | 6 ++++-- 2 files changed, 11 insertions(+), 13 deletions(-) (limited to 'doc') diff --git a/doc/devel/atf.dox b/doc/devel/atf.dox index ff4e182b..1f3d7912 100644 --- a/doc/devel/atf.dox +++ b/doc/devel/atf.dox @@ -172,11 +172,11 @@ yourtest_unittest.c". name to ATF_TESTS. The tests directory will be built only in case where ATF is enabled, using --with-atf during configure phase. -4. Modify Atffile to include your new test, if needed. Tests in specified -directory must be registered in Atffile. See server/tests/Atffile for -example. Currently every executable with name that falls into *_unittest pattern -will be executed automatically. If you followed naming convention proposed in a -previous step, your test will be included and will be included automatically. +4. Modify Atffile to include your new test, if needed. Tests in the +specified directory must be registered in Atffile. See server/tests/Atffile for +an example. Currently every executable with name of the form *_unittest will be +executed automatically. If you followed naming convention proposed in a previous +step, your test will be included and will be included automatically. 5. Enjoy your improved confidence in the code, as you can run the tests after any change you may want to do: @@ -185,12 +185,8 @@ any change you may want to do: $ make check @endverbatim -or run them manually - -@verbatim -$ cd server/tests -$ atf-run | atf-report -@endverbatim +to run all tests for all components. See \ref atfTests section for more details +on running tests. @section testsAtfCoding ATF Coding Guidelines diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox index e67f290b..ab5f66df 100644 --- a/doc/devel/mainpage.dox +++ b/doc/devel/mainpage.dox @@ -8,8 +8,6 @@ http://www.isc.org/software/dhcp website. @section toc Table Of Contents - - @subpage archSrv - - @subpage archCli - @subpage tests - @subpage testsOverview - @subpage testsAtf @@ -21,6 +19,10 @@ - @subpage doxygen - @subpage valgrind - @subpage debug + + Pages planned to be written: + - @subpage archSrv + - @subpage archCli - @subpage omapi - @subpage omapiIntro - @subpage omapiC -- cgit v1.2.1