Regenerating documentation - Revision history

Irdis at 18:17, 7 November 2020

2020-11-07T18:17:21Z

Irdis at 10:23, 6 July 2017

2017-07-06T10:23:15Z

Irdis at 21:17, 14 June 2017

2017-06-14T21:17:14Z

Irdis: Documentation generator how-to

2017-06-13T20:37:35Z

Documentation generator how-to

New page

Horde3D uses NaturalDocs as documentation generator.

In order to regenerate documentation you'll have to:
#[http://www.naturaldocs.org/download.html Install NaturalDocs]
#Copy horde's css file (api.css) from <Horde's SDK folder>/Horde3D/Docs/html/css to <NaturalDocs folder>/Styles
#Use the following command to generate docs:
<code>naturaldocs -i <full path to Horde SDK folder>\Horde3D\Bindings\C++ -o FramedHTML <OutputPath> -p <ProjectPath> -s api</code>.

OutputPath and ProjectPath should also be full paths, like <code>C:/GeneratedDocs</code>.

NaturalDocs cannot change the name of the css file that is included with generated documentation, so it is always named main.css and resides in <ProjectPath>/styles.
Therefore, the reference to the css file should be changed in the generated docs from <code>../styles/main.css</code> to <code>css/api.css</code>.
After that generated doc file should be renamed to _api.html and copied to <Horde's SDK folder>/Horde3D/Docs/html.

Automated scripts for Windows and Linux are in the works.

← Older revision		Revision as of 21:17, 14 June 2017
Line 13:		Line 13:
	After that generated doc file should be renamed to _api.html and copied to <Horde's SDK folder>/Horde3D/Docs/html.		After that generated doc file should be renamed to _api.html and copied to <Horde's SDK folder>/Horde3D/Docs/html.

−	Automated ~~scripts~~ for ~~Windows and~~ Linux ~~are~~ in the works.	+	Automated script for Linux is in the works.
		+
		+	Automated script for Windows is available. Powershell 2.0 is required.
		+	In order to run the script open (first time only) powershell with administrator rights and type <code>Set-ExecutionPolicy RemoteSigned</code> or <code>Set-ExecutionPolicy Unrestricted</code>.
		+	Open the script with your favorite text editor and change the paths at the top. Run the script.
		+	[[File:Horde3D_generate_docs.ps1]]

@@ Line 1: / Line 1: @@
-Horde3D uses NaturalDocs as documentation generator.
+Horde3D uses NaturalDocs as documentation generator. This instruction is written for the version 1 of NaturalDocs. Version 2 is not tested and may or may not work with the instruction below.
 In order to regenerate documentation you'll have to:
-#[http://www.naturaldocs.org/download.html Install NaturalDocs]
+#[https://www.naturaldocs.org/download/#Legacy Install NaturalDocs].
 #Copy horde's css file (api.css) from <Horde's SDK folder>/Horde3D/Docs/html/css to <NaturalDocs folder>/Styles. On Windows it is likely in C:\Program Files (x86)\NaturalDocs. On Linux it is likely in /usr/share/perl5/naturaldocs.
 #Use the following command to generate docs:

@@ Line 3: / Line 3: @@
 In order to regenerate documentation you'll have to:
 #[http://www.naturaldocs.org/download.html Install NaturalDocs]
-#Copy horde's css file (api.css) from <Horde's SDK folder>/Horde3D/Docs/html/css to <NaturalDocs folder>/Styles
+#Copy horde's css file (api.css) from <Horde's SDK folder>/Horde3D/Docs/html/css to <NaturalDocs folder>/Styles. On Windows it is likely in C:\Program Files (x86)\NaturalDocs. On Linux it is likely in /usr/share/perl5/naturaldocs.
 #Use the following command to generate docs:
 <code>naturaldocs -i <full path to Horde SDK folder>\Horde3D\Bindings\C++ -o FramedHTML <OutputPath> -p <ProjectPath> -s api</code>.
@@ Line 12: / Line 12: @@
 Therefore, the reference to the css file should be changed in the generated docs from <code>../styles/main.css</code> to <code>css/api.css</code>.
 After that generated doc file should be renamed to _api.html and copied to <Horde's SDK folder>/Horde3D/Docs/html.
 Automated script for Windows is available. Powershell 2.0 is required.
 In order to run the script open (first time only) powershell with administrator rights and type <code>Set-ExecutionPolicy RemoteSigned</code> or <code>Set-ExecutionPolicy Unrestricted</code>.
 Open the script with your favorite text editor and change the paths at the top. Run the script.
-[[File:Horde3D_generate_docs.ps1]]