modified css file which gives better visual result for html documentation

delete chm file prior to generation
remove unneeded option for html documentation
added short description to nvglutwidgets.xml
nvGLWidgets, added documentation + fixed module name
simplified getTextSize


git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2218 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
blaszijk
2012-01-02 17:48:55 +00:00
parent fc426ba4cc
commit 6b0d820784
24 changed files with 168 additions and 57 deletions

View File

@ -6,6 +6,9 @@ dot -Tpng nvwidgets.dot > ./images/nvwidgets.png
del nvwidgets.dot
::delete old chm documentation
del *.chm
::create chm documentation
fpdoc --package=nvidia-widgets --descr=nvwidgets.xml --input=../src/nvwidgets/nvWidgets.pas --descr=nvglwidgets.xml --input=../src/nvwidgets/nvglwidgets.pas --descr=nvglutwidgets.xml --input=../src/nvwidgets/nvglutwidgets.pas --descr=nvshaderutils.xml --input=../src/nvglutils/nvshaderutils.pas --css-file=fpdoc.css --format=chm --output=nvwidgets.chm
@ -17,4 +20,4 @@ del /Q /S nvglwidgets\*.html
del /Q /S nvshaderutils\*.html
::create html documentation
fpdoc --package=nvidia-widgets --descr=nvwidgets.xml --input=../src/nvwidgets/nvWidgets.pas --descr=nvglwidgets.xml --input=../src/nvwidgets/nvglwidgets.pas --descr=nvglutwidgets.xml --input=../src/nvwidgets/nvglutwidgets.pas --descr=nvshaderutils.xml --input=../src/nvglutils/nvshaderutils.pas --css-file=fpdoc.css --format=html
fpdoc --package=nvidia-widgets --descr=nvwidgets.xml --input=../src/nvwidgets/nvWidgets.pas --descr=nvglwidgets.xml --input=../src/nvwidgets/nvglwidgets.pas --descr=nvglutwidgets.xml --input=../src/nvwidgets/nvglutwidgets.pas --descr=nvshaderutils.xml --input=../src/nvglutils/nvshaderutils.pas --format=html

View File

@ -1,5 +1,5 @@
/*
$Id: fpdoc.cst,v 1.1 2005/01/02 16:22:16 michael Exp $
$Id: fpdoc.css,v 1.1 2003/03/17 23:03:20 michael Exp $
Default style sheet for FPDoc reference documentation
by Sebastian Guenther, sg@freepascal.org
@ -132,3 +132,35 @@ span.bartitle {
font-style: italic;
color: darkblue
}
span.footer {
font-style: italic;
color: darkblue
}
/* definition list */
dl {
border: 3px double #ccc;
padding: 0.5em;
}
/* definition list: term */
dt {
float: left;
clear: left;
width: auto; /* normally browsers default width of largest item */
padding-right: 20px;
font-weight: bold;
color: darkgreen;
}
/* definition list: description */
dd {
margin: 0 0 0 110px;
padding: 0 0 0.5em 0;
}
/* for browsers in standards compliance mode */
td p {
margin: 0;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

@ -19,9 +19,13 @@
<table cellpadding="0" cellspacing="0">
<tr>
<td valign="top"><p><tt><span class="code"><a href="nvglutwidgets/index.html">nvGlutWidgets</a></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">GLut adaptor class</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code"><a href="nvglwidgets/index.html">nvGLWidgets</a></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">User Interface library specialized for OpenGL</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code"><a href="nvshaderutils/index.html">nvShaderUtils</a></span></tt></p></td>
@ -31,7 +35,7 @@
<tr>
<td valign="top"><p><tt><span class="code"><a href="nvwidgets/index.html">nvWidgets</a></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt"></p></td>
<td><p class="cmt">User Interface library</p></td>
</tr>
</table>
<h2>Description</h2>

View File

@ -1,4 +1,4 @@
<?xml version="1.0"?>
<?xml version="1.0" encoding="utf-8"?>
<fpdoc-descriptions>
<package name="nvidia-widgets">
<module name="nvGLutWidgets">
@ -26,11 +26,11 @@
<element name="GlutUIContext.m_ownPainter">
<short>Variable indicating a default painter object</short>
</element>
<descr>Adaptor classes to integrate the nvWidgets UI library with the GLUT windowing toolkit. The adaptors convert native GLUT UI data to native nvWidgets data. All adaptor classes are implemented as in-line code in this header. The adaptor defaults to using the standard OpenGL painter implementation.
</descr>
<element name="GlutUIContext">
<short>GLut specific UI context</short>
</element>
<short>GLut adaptor class</short>
<descr>Adaptor classes to integrate the nvWidgets UI library with the GLUT windowing toolkit. The adaptors convert native GLUT UI data to native nvWidgets data. All adaptor classes are implemented as in-line code in this header. The adaptor defaults to using the standard OpenGL painter implementation.</descr>
</module>
</package>
</fpdoc-descriptions>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>Reference for unit 'nvGlutWidgets'</h1>
<p></p>
<p>GLut adaptor class</p>
<table cellpadding="0" cellspacing="0">
<tr>
<td><p><tt><span class="code"><span class="kw">uses</span></span></tt></p></td>
@ -28,10 +28,10 @@
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<a href="../nvwidgets/index.html">nvWidgets</a><span class="sym">;</span> </span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt"></p></td>
<td><p class="cmt">User Interface library</p></td>
</tr>
</table>
<h2>Overview</h2>
<p>Adaptor classes to integrate the nvWidgets UI library with the GLUT windowing toolkit. The adaptors convert native GLUT UI data to native nvWidgets data. All adaptor classes are implemented as in-line code in this header. The adaptor defaults to using the standard OpenGL painter implementation. </p>
<p>Adaptor classes to integrate the nvWidgets UI library with the GLUT windowing toolkit. The adaptors convert native GLUT UI data to native nvWidgets data. All adaptor classes are implemented as in-line code in this header. The adaptor defaults to using the standard OpenGL painter implementation.</p>
</body>
</html>

View File

@ -1,13 +1,60 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="nvidia-widgets">
<module name="nvWidgets">
<module name="nvGLWidgets">
<element name="nvGLWidgets">
<short>User Interface library</short>
</element>
<element name="GLUIPainter">
<short>OpenGL painter class</short>
</element>
<element name="GLUIPainter.getCanvasMargin">
<short>Evaluate canvas margin</short>
</element>
<element name="GLUIPainter.getCanvasSpace">
<short>Evaluate canvas space</short>
</element>
<element name="GLUIPainter.getFontHeight">
<short>Evaluate font height</short>
</element>
<element name="GLUIPainter.getTextLineWidth">
<short>Evaluate text width</short>
</element>
<element name="GLUIPainter.getTextSize">
<short>Evaluate text size</short>
<descr>
<p>
<var>getTextSize</var>
evaluates a string, it will calculate the number of lines it consists of and will return the length in pixels of the longest line.</p>
</descr>
</element>
<element name="GLUIPainter.getCanvasMargin.Result">
<short>Exterior margin</short>
</element>
<element name="GLUIPainter.getCanvasSpace.Result">
<short>Interior margin</short>
</element>
<element name="GLUIPainter.getFontHeight.Result">
<short>Font height in pixels</short>
</element>
<element name="GLUIPainter.getTextLineWidth.Result">
<short>Text width</short>
</element>
<element name="GLUIPainter.getTextSize.Result">
<short>Text width of widest line</short>
</element>
<element name="GLUIPainter.drawDebugRect">
<short>Draw a rectangle for debuggin purposes</short>
<descr>
<p>
<var>drawDebugRect</var>
draws a simple rectangle usefull for debugging purposes.</p>
</descr>
</element>
<element name="GLUIPainter.drawDebugRect.r">
<short>Rectangle size to draw</short>
</element>
<short>User Interface library specialized for OpenGL</short>
</module>
</package>
</fpdoc-descriptions>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>GLUIPainter.drawDebugRect</h1>
<p></p>
<p>Draw a rectangle for debuggin purposes</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 177</p>
<table cellpadding="0" cellspacing="0">
@ -28,5 +28,15 @@
<td><p><tt><span class="code"><span class="sym">)</span><span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
</tr>
</table>
<h2>Arguments</h2>
<table cellpadding="0" cellspacing="0">
<tr>
<td valign="top"><p><tt><span class="code">r</span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Rectangle size to draw</p></td>
</tr>
</table>
<h2>Description</h2>
<p><var>drawDebugRect</var> draws a simple rectangle usefull for debugging purposes.</p>
</body>
</html>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>GLUIPainter.getCanvasMargin</h1>
<p></p>
<p>Evaluate canvas margin</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 169</p>
<table cellpadding="0" cellspacing="0">
@ -22,5 +22,7 @@
<td><p><tt><span class="code"> <span class="kw">public</span> <span class="kw">function</span> <a href="../nvglwidgets/gluipainter.html">GLUIPainter</a><span class="sym">.</span>getCanvasMargin<span class="sym">: </span>Integer<span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
</tr>
</table>
<h2>Function result</h2>
<p>Exterior margin</p>
</body>
</html>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>GLUIPainter.getCanvasSpace</h1>
<p></p>
<p>Evaluate canvas space</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 170</p>
<table cellpadding="0" cellspacing="0">
@ -22,5 +22,7 @@
<td><p><tt><span class="code"> <span class="kw">public</span> <span class="kw">function</span> <a href="../nvglwidgets/gluipainter.html">GLUIPainter</a><span class="sym">.</span>getCanvasSpace<span class="sym">: </span>Integer<span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
</tr>
</table>
<h2>Function result</h2>
<p>Interior margin</p>
</body>
</html>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>GLUIPainter.getFontHeight</h1>
<p></p>
<p>Evaluate font height</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 171</p>
<table cellpadding="0" cellspacing="0">
@ -22,5 +22,7 @@
<td><p><tt><span class="code"> <span class="kw">public</span> <span class="kw">function</span> <a href="../nvglwidgets/gluipainter.html">GLUIPainter</a><span class="sym">.</span>getFontHeight<span class="sym">: </span>Integer<span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
</tr>
</table>
<h2>Function result</h2>
<p>Font height in pixels</p>
</body>
</html>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>GLUIPainter.getTextLineWidth</h1>
<p></p>
<p>Evaluate text width</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 172</p>
<table cellpadding="0" cellspacing="0">
@ -28,5 +28,7 @@
<td><p><tt><span class="code"><span class="sym">):</span>Integer<span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
</tr>
</table>
<h2>Function result</h2>
<p>Text width</p>
</body>
</html>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>GLUIPainter.getTextSize</h1>
<p></p>
<p>Evaluate text size</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 173</p>
<table cellpadding="0" cellspacing="0">
@ -31,5 +31,9 @@
<td><p><tt><span class="code"><span class="sym">):</span>Integer<span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
</tr>
</table>
<h2>Function result</h2>
<p>Text width of widest line</p>
<h2>Description</h2>
<p><var>getTextSize</var> evaluates a string, it will calculate the number of lines it consists of and will return the length in pixels of the longest line.</p>
</body>
</html>

View File

@ -15,7 +15,7 @@
</table>
<h1>GLUIPainter</h1>
<p>[<a href="../nvglwidgets/gluipainter-1.html" onClick="window.open('../nvglwidgets/gluipainter-1.html', 'list', 'dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300'); return false;">Properties</a> (<a href="../nvglwidgets/gluipainter-2.html" onClick="window.open('../nvglwidgets/gluipainter-2.html', 'list', 'dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300'); return false;">by Name</a>)] [<a href="../nvglwidgets/gluipainter-3.html" onClick="window.open('../nvglwidgets/gluipainter-3.html', 'list', 'dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300'); return false;">Methods</a> (<a href="../nvglwidgets/gluipainter-4.html" onClick="window.open('../nvglwidgets/gluipainter-4.html', 'list', 'dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300'); return false;">by Name</a>)] [<a href="../nvglwidgets/gluipainter-5.html" onClick="window.open('../nvglwidgets/gluipainter-5.html', 'list', 'dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300'); return false;">Events</a> (<a href="../nvglwidgets/gluipainter-6.html" onClick="window.open('../nvglwidgets/gluipainter-6.html', 'list', 'dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300'); return false;">by Name</a>)] </p>
<p></p>
<p>OpenGL painter class</p>
<h2>Declaration</h2>
<p>Source position: nvglwidgets.pas line 122</p>
<table cellpadding="0" cellspacing="0">
@ -117,18 +117,28 @@
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvglwidgets/gluipainter.getcanvasmargin.html">getCanvasMargin</a><span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Evaluate canvas margin</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvglwidgets/gluipainter.getcanvasspace.html">getCanvasSpace</a><span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Evaluate canvas space</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvglwidgets/gluipainter.getfontheight.html">getFontHeight</a><span class="sym">;</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Evaluate font height</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvglwidgets/gluipainter.gettextlinewidth.html">getTextLineWidth</a><span class="sym">();</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Evaluate text width</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvglwidgets/gluipainter.gettextsize.html">getTextSize</a><span class="sym">();</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Evaluate text size</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">function </span><a href="../nvglwidgets/gluipainter.gettextlinewidthat.html">getTextLineWidthAt</a><span class="sym">();</span></span></tt></p></td>
@ -138,6 +148,8 @@
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvglwidgets/gluipainter.drawdebugrect.html">drawDebugRect</a><span class="sym">();</span><span class="kw"> override</span><span class="sym">;</span></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Draw a rectangle for debuggin purposes</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">procedure </span><a href="../nvglwidgets/gluipainter.drawtext.html">drawText</a><span class="sym">();</span></span></tt></p></td>
@ -183,6 +195,8 @@
<table cellpadding="0" cellspacing="0">
<tr>
<td align="center" valign="top"><p><tt><span class="code"><a href="../nvglwidgets/gluipainter.html">GLUIPainter</a></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">OpenGL painter class</p></td>
</tr>
<tr>
<td align="center">|</td>

View File

@ -17,6 +17,8 @@
<table cellpadding="0" cellspacing="0">
<tr>
<td valign="top"><p><tt><span class="code"><a href="../nvglwidgets/gluipainter.html">GLUIPainter</a></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">OpenGL painter class</p></td>
</tr>
</table>
</body>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>Reference for unit 'nvGLWidgets'</h1>
<p></p>
<p>User Interface library specialized for OpenGL</p>
<table cellpadding="0" cellspacing="0">
<tr>
<td><p><tt><span class="code"><span class="kw">uses</span></span></tt></p></td>
@ -28,7 +28,7 @@
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;<a href="../nvwidgets/index.html">nvWidgets</a><span class="sym">,</span> </span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt"></p></td>
<td><p class="cmt">User Interface library</p></td>
</tr>
<tr>
<td valign="top"><p><tt><span class="code">&nbsp;&nbsp;GL<span class="sym">;</span> </span></tt></p></td>

View File

@ -2,10 +2,10 @@
<fpdoc-descriptions>
<package name="nvidia-widgets">
<module name="nvShaderUtils">
<element name="CompileGLSLShader"/>
<short>Utility functions for compiling shaders and programs</short>
<element name="CompileGLSLShader"/>
<element name="LinkGLSLProgram">
<short>Create a program composed of vertex and fragment shaders.</short>
<short>Create a program composed of vertex, geometry and fragment shaders.</short>
</element>
</module>
</package>

View File

@ -30,7 +30,7 @@
<tr>
<td valign="top"><p><tt><span class="code"><a href="../nvshaderutils/linkglslprogram.html">LinkGLSLProgram</a></span></tt></p></td>
<td><p>&nbsp;&nbsp;</p></td>
<td><p class="cmt">Create a program composed of vertex and fragment shaders.</p></td>
<td><p class="cmt">Create a program composed of vertex, geometry and fragment shaders.</p></td>
</tr>
</table>
</body>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>LinkGLSLProgram</h1>
<p>Create a program composed of vertex and fragment shaders.</p>
<p>Create a program composed of vertex, geometry and fragment shaders.</p>
<h2>Declaration</h2>
<p>Source position: line 0</p>
<table cellpadding="0" cellspacing="0">

View File

@ -1,9 +1,7 @@
<?xml version="1.0"?>
<?xml version="1.0" encoding="utf-8"?>
<fpdoc-descriptions>
<package name="nvidia-widgets">
<module name="nvWidgets">
<short/>
<descr/>
<element name="Point">
<short>2D point object</short>
</element>
@ -239,6 +237,7 @@ False equals 0</descr>
<element name="UIContext.beginGroup">
<short>Begin grouping section of UI objects</short>
</element>
<short>User Interface library</short>
</module>
<short>NVIDIA widget library</short>
<descr>

View File

@ -14,7 +14,7 @@
</tr>
</table>
<h1>Reference for unit 'nvWidgets'</h1>
<p></p>
<p>User Interface library</p>
<table cellpadding="0" cellspacing="0">
<tr>
<td><p><tt><span class="code"><span class="kw">uses</span></span></tt></p></td>

View File

@ -140,6 +140,7 @@ var
// Pass non-ui mouse events to the manipulator
//updateManipulator(ui, manipulator);
ui._end;
end;

View File

@ -278,6 +278,7 @@ begin
glDeleteLists(m_foregroundDL, 1);
m_foregroundDL := 0;
end;
//Restore state.
glCallList(m_restoreStateDL);
end;
@ -800,37 +801,23 @@ end;
function GLUIPainter.getTextSize(const Text: string; out nbLines: integer): integer;
var
w: integer;
wLine: integer;
w: integer = 0;
i: integer;
s: TStrings;
t: string;
j: Integer;
begin
s := TStringList.Create;
try
s.Text:= Text;
w := 0;
wLine := 0;
nbLines := s.Count;
for i := 0 to nbLines - 1 do
begin
wLine := 0;
t := s[i];
for j := 1 to Length(t) do
wLine := wLine + glutBitmapWidth(GLUT_BITMAP_HELVETICA_12, Ord(t[j]));
w := Max(w, wLine);
end;
w := Max(w, getTextLineWidth(s[i]));
finally
s.Free;
end;
Result := Max(w, wLine) + 2;
Result := w;
end;
function GLUIPainter.getTextLineWidthAt(const Text: string; charNb: integer): integer;
@ -885,11 +872,11 @@ end;
procedure GLUIPainter.drawDebugRect(const r: Rect);
begin
glBegin(GL_LINE_STRIP);
glVertex2i(r.x + 1, r.y + 1);
glVertex2i(r.x + r.w, r.y + 1);
glVertex2i(r.x, r.y);
glVertex2i(r.x + r.w, r.y);
glVertex2i(r.x + r.w, r.y + r.h);
glVertex2i(r.x + 1, r.y + r.h);
glVertex2i(r.x + 1, r.y);
glVertex2i(r.x, r.y + r.h);
glVertex2i(r.x, r.y);
glEnd;
end;