Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update help generation to output to BuildOutput/Help to keep director…

…ies consistent

Html help is now generated to html-shfb and html-mdoc directories
Include default namespace descriptions for mdoc xml
  • Loading branch information...
commit 1f788ff33715fc10e8276cca8cfe700aba2de2fa 1 parent 251e2b2
@cwensley cwensley authored
View
3  .gitignore
@@ -4,4 +4,5 @@
*.suo
bin/
obj/
-/BuildOutput
+/BuildOutput
+*.shfbproj_*
View
2  Help/Help.shfbproj
@@ -15,7 +15,7 @@
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
- <OutputPath>..\BuildOutput\Docs\help\</OutputPath>
+ <OutputPath>..\BuildOutput\Help\html-shfb\</OutputPath>
<HtmlHelpName>EtoForms</HtmlHelpName>
<Language>en-US</Language>
<HelpFileFormat>Website</HelpFileFormat>
View
BIN  Help/Help.shfbproj_Administrator
Binary file not shown
View
11 Help/buildmdoc.sh
@@ -4,13 +4,16 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
BUILD_OUTPUT_PATH=$DIR/../BuildOutput
INPUT_PATH=$BUILD_OUTPUT_PATH/Debug
-OUTPUT_PATH=$BUILD_OUTPUT_PATH/Docs
+OUTPUT_PATH=$BUILD_OUTPUT_PATH/Help
MDOC_OUTPUT_PATH=$OUTPUT_PATH/mdoc
MDOC_SOURCES_PATH=$MDOC_OUTPUT_PATH/sources
XML_OUTPUT_PATH=$OUTPUT_PATH/xml
+HTML_OUTPUT_PATH=$OUTPUT_PATH/html-mdoc
rm -rf $MDOC_OUTPUT_PATH
rm -rf $XML_OUTPUT_PATH
+mkdir -p $XML_OUTPUT_PATH
+cp -r $DIR/xml/* $XML_OUTPUT_PATH
mdoc update -i "$INPUT_PATH/Eto.XML" -o "$XML_OUTPUT_PATH" "$INPUT_PATH/Eto.dll"
mkdir -p $MDOC_SOURCES_PATH
mdoc assemble -o "$MDOC_SOURCES_PATH/Eto" "$XML_OUTPUT_PATH"
@@ -32,3 +35,9 @@ MONODOC='<?xml version="1.0"?>\n
</node>'
echo -e $MONODOC > $MDOC_OUTPUT_PATH/monodoc.xml
+
+if [ "$1" == "html" ]
+then
+ rm -rf $HTML_OUTPUT_PATH
+ mdoc export-html -out "$HTML_OUTPUT_PATH" "$XML_OUTPUT_PATH"
+fi
View
4 Help/xml/index.xml
@@ -0,0 +1,4 @@
+<Overview>
+ <Remarks>Eto Cross Platform Framework</Remarks>
+ <Copyright>(c) 2012 by Curtis Wensley</Copyright>
+</Overview>
View
6 Help/xml/ns-Eto.Drawing.xml
@@ -0,0 +1,6 @@
+<Namespace Name="Eto.Drawing">
+ <Docs>
+ <summary>Graphics and Drawing</summary>
+ <remarks>Graphics and drawing routines</remarks>
+ </Docs>
+</Namespace>
View
6 Help/xml/ns-Eto.Forms.xml
@@ -0,0 +1,6 @@
+<Namespace Name="Eto.Forms">
+ <Docs>
+ <summary>User Interface</summary>
+ <remarks>User interface forms and controls</remarks>
+ </Docs>
+</Namespace>
View
6 Help/xml/ns-Eto.IO.xml
@@ -0,0 +1,6 @@
+<Namespace Name="Eto.IO">
+ <Docs>
+ <summary>Abstracted I/O</summary>
+ <remarks>Abstracted input/output interfaces</remarks>
+ </Docs>
+</Namespace>
View
6 Help/xml/ns-Eto.Misc.xml
@@ -0,0 +1,6 @@
+<Namespace Name="Eto.Misc">
+ <Docs>
+ <summary>Obsolete namespace</summary>
+ <remarks>Obsolete namespace</remarks>
+ </Docs>
+</Namespace>
View
6 Help/xml/ns-Eto.xml
@@ -0,0 +1,6 @@
+<Namespace Name="Eto">
+ <Docs>
+ <summary>Core functionality</summary>
+ <remarks>Core functionality of the Eto framework</remarks>
+ </Docs>
+</Namespace>
Please sign in to comment.
Something went wrong with that request. Please try again.