Standards for Internal Documentation - Revision history

Dvernon at 08:39, 20 January 2020

2020-01-20T08:39:11Z

Dvernon at 08:38, 20 January 2020

2020-01-20T08:38:47Z

Dvernon at 08:38, 20 January 2020

2020-01-20T08:38:23Z

Dvernon at 08:37, 20 January 2020

2020-01-20T08:37:17Z

Dvernon at 08:36, 20 January 2020

2020-01-20T08:36:15Z

Dvernon at 08:34, 20 January 2020

2020-01-20T08:34:39Z

Dvernon: /* Implementation Comments */

2015-02-17T08:35:52Z

‎Implementation Comments

Dvernon at 08:35, 17 February 2015

2015-02-17T08:35:10Z

Dvernon at 08:21, 17 February 2015

2015-02-17T08:21:53Z

Dvernon: Dvernon moved page Mandatory Standards for Internal Documentation to Standards for Internal Documentation

2015-02-15T12:22:05Z

Dvernon moved page Mandatory Standards for Internal Documentation to Standards for Internal Documentation

@@ Line 176: / Line 176: @@
+  }
-−
 '''End-Of-Line Comments'''

@@ Line 46: / Line 46: @@
 The following is a list of the mandatory sections for which documentation comments must be provided. These are taken from the example <code>protoComponent.h</code> file and you should refer to the full listing of this file in the CINDY repository and to the software development guidelines on the wiki.
-/**
+ /**
- *@file protoComponent.h
+  *@file protoComponent.h
-−
+  *
   ...

@@ Line 46: / Line 46: @@
 The following is a list of the mandatory sections for which documentation comments must be provided. These are taken from the example <code>protoComponent.h</code> file and you should refer to the full listing of this file in the CINDY repository and to the software development guidelines on the wiki.
- /**
+/**
   *@file protoComponent.h
-−
+ *
   ...

@@ Line 47: / Line 47: @@
   /**
-  *@file protoComponent.h
+ *@file protoComponent.h
+   *

@@ Line 47: / Line 47: @@
   /**
-   * @file protoComponent.h
+   *@file protoComponent.h
+   *
@@ Line 166: / Line 166: @@
 Very short comments can appear on the same line as the code they describe, but should be shifted far enough to separate them from the statements. If more than one short comment appears in a segment of code, they should all be indented to the same level.
   if (a == b) {
      return TRUE;
+  }

← Older revision		Revision as of 08:34, 20 January 2020
Line 198:		Line 198:
	// return false; // need to explain why		// return false; // need to explain why
	//}		//}
−
−
−
−	~~----~~
−	~~Return to [[The CINDY Cognitive Architecture]] main page.~~

@@ Line 143: / Line 143: @@
   /*
    * Author:  <name of author>, <author institute>
-   * Email:    <preferred email address>
+   * Email:   <preferred email address>
    * Website: <preferred web address, if any>
+   *

@@ Line 17: / Line 17: @@
 == Documentation Comments ==
-Documentation comments often describe classes, constructors, destructors, methods, members, and functions. However, in DREAM we will use it to provide external documentation on the 4Cs: component functionality (i.e. computation), configuration, communication (through ports), and coordination (through ports, including the module-name port).
+Documentation comments often describe classes, constructors, destructors, methods, members, and functions. However, in CINDY we will use it to provide external documentation on the 4Cs: component functionality (i.e. computation), configuration, communication (through ports), and coordination (through ports, including the module-name port).
@@ Line 44: / Line 44: @@
-The following is a list of the mandatory sections for which documentation comments must be provided. These are taken from the example <code>protoComponent.h</code> file and you should refer to the full listing of this file in the DREAM SVN repository and to the software development guidelines on the DREAM wiki.
+The following is a list of the mandatory sections for which documentation comments must be provided. These are taken from the example <code>protoComponent.h</code> file and you should refer to the full listing of this file in the CINDY repository and to the software development guidelines on the wiki.
   /**
@@ Line 119: / Line 119: @@
   * <forename> <surname>
+  *
-  * Copyright (C) 2014 DREAM Consortium
+  * Copyright (C) 2015
+  *
   */
 ===Implementation Comments===
@@ Line 140: / Line 142: @@
   /*
    * Author:  <name of author>, <author institute>
-   * Email:   <preferred email address>
+   * Email:    <preferred email address>
-   * Website: www.dream20202.eu
+   * Website: <preferred web address, if any>
+   *
-   * This program comes with ABSOLUTELY NO WARRANTY.
+   * This program comes with ABSOLUTELY NO WARRANTY
    */

← Older revision		Revision as of 08:21, 17 February 2015
Line 199:		Line 199:
	// return false; // need to explain why		// return false; // need to explain why
	//}		//}
		+
		+
		+
		+	----
		+	Return to [[The CINDY Cognitive Architecture]] main page.

← Older revision	Revision as of 12:22, 15 February 2015
(No difference)