Test Documentation in C/C++ - Revision history

Ivailop at 19:03, 28 December 2018

2018-12-28T19:03:46Z

← Older revision		Revision as of 19:03, 28 December 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	Stride provides an integrated solution for automatically extracting documentation for your test units using the well-known [~~http~~://~~www~~.~~stack~~.nl/~~~dimitri/doxygen~~/ doxygen format].		Stride provides an integrated solution for automatically extracting documentation for your test units using the well-known [https://en.wikipedia.org/wiki/Doxygen doxygen format].

	'''Test documentation'''		'''Test documentation'''
Line 18:		Line 18:

	In order to enable test unit documentation, here is summary of the necessary steps:		In order to enable test unit documentation, here is summary of the necessary steps:
	* document your test unit source with [http://www.~~stack~~.nl/~~~dimitri/doxygen~~/docblocks.html doxygen] formatted blocks. Since only header files are typically passed to the [[S2scompile\|Stride Compiler]], we recommend you place your documentation in the header file.		* document your test unit source with [http://www.doxygen.nl/manual/docblocks.html doxygen] formatted blocks. Since only header files are typically passed to the [[S2scompile\|Stride Compiler]], we recommend you place your documentation in the header file.
	* configure your build/make process to call the [[S2scompile\|Stride Compiler]] with the additional '''--documentation''' flag. If you are using one of our preconfigured makefiles in a sandbox environment, this option has already been enabled.		* configure your build/make process to call the [[S2scompile\|Stride Compiler]] with the additional '''--documentation''' flag. If you are using one of our preconfigured makefiles in a sandbox environment, this option has already been enabled.
	* run your build process to produce a Stride database and Stride enabled target application.		* run your build process to produce a Stride database and Stride enabled target application.
Line 31:		Line 31:
	More advanced doxygen formatting tags (such as tables and parameter lists) are not supported at this time, but will likely be in future releases.		More advanced doxygen formatting tags (such as tables and parameter lists) are not supported at this time, but will likely be in future releases.

	For more information on Doxygen formatting, see [http://www.doxygen.nl/docblocks.html]		For more information on Doxygen formatting, see [http://www.doxygen.nl/manual/docblocks.html]

	== Test Classes ==		== Test Classes ==

Marku at 17:01, 6 July 2015

2015-07-06T17:01:11Z

← Older revision		Revision as of 17:01, 6 July 2015
Line 18:		Line 18:

	In order to enable test unit documentation, here is summary of the necessary steps:		In order to enable test unit documentation, here is summary of the necessary steps:
	* document your test unit source with [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen] formatted blocks. Since only header files are typically passed to the [[S2scompile\|Stride ~~compiler~~]], we recommend you place your documentation in the header file.		* document your test unit source with [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen] formatted blocks. Since only header files are typically passed to the [[S2scompile\|Stride Compiler]], we recommend you place your documentation in the header file.
	* configure your build/make process to call the [[S2scompile\|Stride ~~compiler~~]] with the additional '''--documentation''' flag. If you are using one of our preconfigured makefiles in a sandbox environment, this option has already been enabled.		* configure your build/make process to call the [[S2scompile\|Stride Compiler]] with the additional '''--documentation''' flag. If you are using one of our preconfigured makefiles in a sandbox environment, this option has already been enabled.
	* run your build process to produce a Stride database and Stride enabled target application.		* run your build process to produce a Stride database and Stride enabled target application.
	* start your application and execute the [[~~Stride_Runner\|~~Stride ~~runner~~]] to connect and run the tests.		* start your application and execute the [[Stride Runner]] to connect and run the tests.
	* The generated report will contain description information for the test suites and test cases generated from the doxygen blocks.		* The generated report will contain description information for the test suites and test cases generated from the doxygen blocks.

	'''Doxygen''' has a rich set of tags and formatting options aimed at comprehensive source documentation. The ~~STRIDE Framework~~ uses doxygen on a per-file basis to extract standalone documentation for individual test units and their methods. As such, we only support limited set of doxygen features in the code documentation. The ~~STRIDE Framework~~ supports the following doc formatting:		'''Doxygen''' has a rich set of tags and formatting options aimed at comprehensive source documentation. The Stride test framework uses doxygen on a per-file basis to extract standalone documentation for individual test units and their methods. As such, we only support limited set of doxygen features in the code documentation. The Stride test framework supports the following doc formatting:
	* custom HTML formatting		* custom HTML formatting
	* lists (ordered, unordered, definition)		* lists (ordered, unordered, definition)

Marku at 16:39, 1 July 2015

2015-07-01T16:39:59Z

@@ Line 1: / Line 1: @@
-== Introduction ==
+__NOTOC__
-The STRIDE Framework provides an integrated solution for automatically  extracting  documentation for your test units using the well-known [http://www.stack.nl/~dimitri/doxygen/ doxygen format]. In order to enable test unit documentation, here is summary of the necessary steps:
+Stride provides an integrated solution for automatically extracting  documentation for your test units using the well-known [http://www.stack.nl/~dimitri/doxygen/ doxygen format].
-* document your test unit source with [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen] formatted blocks. Since only header files are typically passed to the [[S2scompile|Stride  compiler]], we recommend you place your   documentation in the header file.
 * configure your build/make process to call the [[S2scompile|Stride compiler]] with the additional '''--documentation''' flag. If you are using one of our preconfigured makefiles in a sandbox environment, this option has already been enabled.
 * run your build process to produce a Stride database and Stride enabled target application.
@@ Line 7: / Line 24: @@
 * The generated report will contain description information for the test suites and test cases generated from the doxygen blocks.
-== Recommendations and Guidelines ==
+'''Doxygen''' has a rich set of tags  and formatting options aimed at comprehensive  source documentation. The STRIDE Framework uses doxygen on a per-file  basis to extract standalone  documentation for individual test units and  their methods. As such, we  only support limited set of doxygen  features in the code documentation. The STRIDE Framework supports the  following doc formatting:
 * custom HTML formatting
 * lists (ordered, unordered, definition)
@@ Line 30: / Line 33: @@
 For more information on Doxygen formatting, see [http://www.doxygen.nl/docblocks.html]
-== Examples ==
+== Test Classes ==
 <source lang=cpp>
 #pragma once
@@ Line 62: / Line 66: @@
 </source>
-=== Test C-Class ===
 <source lang=c>
 #pragma once
@@ Line 97: / Line 105: @@
 </source>
-=== Test FList ===
 (source file name is ''my_flist.h'' in the example below)
 <source lang=c>
@@ Line 132: / Line 144: @@
 </source>

Ivailop at 22:50, 26 November 2014

2014-11-26T22:50:30Z

Show changes

Ivailop: /* Test Class */

2014-11-26T22:41:21Z

Test Class

← Older revision		Revision as of 22:41, 26 November 2014
Line 43:		Line 43:


	class MyTestClass{		class MyTestClass
			{
	public:		public:
	/*!		/*!

Ivailop: /* Test FList */

2014-11-26T22:40:56Z

Test FList

← Older revision		Revision as of 22:40, 26 November 2014
Line 110:		Line 110:
	/*!		/*!
	\flist my_flist.h		\flist my_flist.h
	~~\brief Summary~~ description for my_flist(optional)		Brief description for my_flist(optional)

	More detailed documentation goes here		More detailed documentation goes here
Line 117:		Line 117:

	/*!		/*!
	Description for Test_1 here.		Description for Test_1 here.
	*/		*/
	int Test_1();		int Test_1();

Ivailop: /* Test Class */

2014-11-26T22:40:07Z

Test Class

← Older revision		Revision as of 22:40, 26 November 2014
Line 33:		Line 33:

	=== Test Class ===		=== Test Class ===
	<source lang=~~c++~~>		<source lang=cpp>
	#pragma once		#pragma once
	#include <srtest.h>		#include <srtest.h>

Ivailop: /* Test Class */

2014-11-26T22:39:26Z

Test Class

← Older revision		Revision as of 22:39, 26 November 2014
Line 33:		Line 33:

	=== Test Class ===		=== Test Class ===
	<source lang=c>		<source lang=c++>
	#pragma once		#pragma once
	#include <srtest.h>		#include <srtest.h>

Ivailop: /* Test C-Class */

2014-11-26T22:39:15Z

Test C-Class

← Older revision		Revision as of 22:39, 26 November 2014
Line 62:		Line 62:

	=== Test C-Class ===		=== Test C-Class ===
	<source lang=c>		<source lang=c>
	#pragma once		#pragma once
	#include <srtest.h>		#include <srtest.h>

	/*! ~~\brief Summary~~ description for my_c_class(optional)		/*! Brief description for my_c_class(optional)

	More detailed documentation goes here		More detailed documentation goes here

	*/		*/
Line 74:		Line 74:
	{		{
	/*!		/*!
	Description for Test_1 here.		Description for Test_1 here.
	*/		*/
	int (Test_1)(struct my_c_class pcc);		int (Test_1)(struct my_c_class pcc);

	/*!		/*!
	Description for Test_2 here.		Description for Test_2 here.
	*/		*/
	int (Test_2)(struct my_c_class pcc);		int (Test_2)(struct my_c_class pcc);

Ivailop: /* Test Class */

2014-11-26T22:38:18Z

Test Class

← Older revision		Revision as of 22:38, 26 November 2014
Line 37:		Line 37:
	#include <srtest.h>		#include <srtest.h>

	/*! ~~\brief Description~~ for MyTestUnit (optional)		/*! Brief description for MyTestUnit (optional)
	More detailed documentation goes here		More detailed documentation goes here.
	~~This example shows the C++ commenting style, the C style may also be used~~.
	<a href="http:\\myinfo.mysite.com\MyTestUnit.html">More Info</a>		<a href="http:\\myinfo.mysite.com\MyTestUnit.html">More Info</a>
	*/		*/