Changeset 940 for specdomain/src/specdomain/test/test_doc.rst

Timestamp:

Jun 17, 2012 1:48:58 PM (11 years ago)

Author:

jemian

Message:

refs #8, making progress, discard code from previous attempt

File:

• specdomain/src/specdomain/test/test_doc.rst (modified) (3 diffs)

specdomain/src/specdomain/test/test_doc.rst

@@ -101 +101 @@
 * local variable declaration:  :spec:local:`i`
 * array variable declaration: 
+* constant declaration:
 
 Python example
@@ -129 +130 @@
 ^^^^^^^^^^^^^^
 
-* global variable declaration: 
-* local variable declaration: 
+The SPEC macro language provides for several types of variable:
+
+* global variables, such as:  :spec:global:`A[]`
+* local variable, such as:  :spec:local:`i`
 * array variable declaration: 
+* constant declaration:
+
+Source code documentation
+============================
 
 Python example
@@ -137 +144 @@
 
 See the python method :py:func:`python_function()` (defined above)
+
+..  This should document the Python module supporting the specdomain
+
+:class:`SpecVariableObject` (Python Module)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: sphinxcontrib.specdomain.SpecVariableObject
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: sphinxcontrib.specdomain
+    :members:
+
+
+
+SPEC macro source file
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. spec:macrofile:: cdef-examples.mac