added doc notes

Author: jackbrookes

docs/REAMDE.md

@@ -0,0 +1,11 @@
+## Building the documentation
+
+1. Enable XML documentation generation in Visual Studio project settings
+2. Build the project
+3. Run the markdown generator script and put files in docs/wiki/Generated folder `python xml2md.py /path/to/docs.xml wiki/Generated`
+
+## Notes   
+
+* Documentation is posted on the [Wiki](https://github.com/jackbrookes/unity-experiment-framework/wiki)
+* The python script requires [markdown-generator](https://github.com/cmccandless/markdown-generator) to run (`pip install markdown-generator`)
+

docs/wiki

@@ -92,20 +92,20 @@ def to_md(self, directory):
                     blockquote.append(summary_from_member(method))
                     blockquote.append("")
                     blockquote.append(mg.strong("Parameters"))
-                    writer.write(blockquote)
+                    blockquote.append("")
                     params = [p for p in method if p.tag == "param"]
 
-                    blockquote2 = mg.BlockQuote(level=2)
+                    pre = "* "
                     if len(params) == 0:
-                        blockquote2.append(mg.emphasis("None"))
+                        blockquote.append(mg.emphasis("None"))
                     else:
                         for param in params:
                             param_name = param.attrib["name"]
                             param_text = param.text if param.text is not None else ""
-                            blockquote2.append(inline_code(
+                            blockquote.append(pre + inline_code(
                                 param_name) + ": " + param_text)
-                            blockquote2.append("")
-                    writer.write(blockquote2)
+                            blockquote.append("")
+                    writer.write(blockquote)
 
 
             writer.write_hrule()