Menu ▾ ▴

#508 'DoxyGen'-like documentation generator for procedures

v1.1.x
closed
Erik Hänel
None
v1.1.2
New Functionality
2020-03-31
2020-01-22
Erik Hänel
No

Create a "DoxyGen"-like documentation generator for procedures, which shall create the documentation section of procedure heads including the list of arguments by a simple key stroke.

Analysis:

This is a quite straightforward implementation. Requires few logic steps, except of some new highlighting features.

Implementation:

  • Implementation: The implementation was carried out as indicated by the analysis.
  • Revision: [r684]
  • Implementation test: Documentation blocks for different procedures were created and tested in tooltip and documentation creation scenarios.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

This new functionality was tested manually. No deviations detected. Functionality implemented successfully.

Related

Commit: [r684]

Discussion

  • Erik Hänel

    Erik Hänel - 2020-01-29
    • status: open --> accepted
    • Version: Planned --> v1.1.2
     

  • Erik Hänel

    Erik Hänel - 2020-02-01
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 Create a "DoxyGen"-like documentation generator for procedures, which shall create the documentation section of procedure heads including the list of arguments by a simple key stroke.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2020-02-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 Create a "DoxyGen"-like documentation generator for procedures, which shall create the documentation section of procedure heads including the list of arguments by a simple key stroke.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+This is a quite straightforward implementation. Requires few logic steps, except of some new highlighting features.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2020-02-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,19 +4,19 @@
 This is a quite straightforward implementation. Requires few logic steps, except of some new highlighting features.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: The implementation was carried out as indicated by the analysis.
+* Revision: [r684]
+* Implementation test: Documentation blocks for different procedures were created and tested in tooltip and documentation creation scenarios.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r684]

  • Erik Hänel

    Erik Hänel - 2020-03-31
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+This new functionality was tested manually. No deviations detected. Functionality implemented successfully.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB