Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gcasa committed Dec 22, 2023
1 parent 74aba98 commit 8aee10d
Show file tree
Hide file tree
Showing 525 changed files with 213,586 additions and 15,247 deletions.
13 changes: 13 additions & 0 deletions resources/documentation/Developer/Gui/Additions/ClassesTOC.gsdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="Classes" stylesheeturl="gsdoc_contents">
<head>
<title>Classes</title>
</head>
<body>
<chapter>
<index type="class" scope="project" target="mainFrame"
style="bare" />
</chapter>
</body>
</gsdoc>
14 changes: 7 additions & 7 deletions resources/documentation/Developer/Gui/Additions/ClassesTOC.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ <h2><a name="title$Classes">Classes</a></h2>



<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSHbox.html#class$GSHbox">GSHbox</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSTheme.html#class$GSPageLayout">GSPageLayout</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSTheme.html#class$GSPrintPanel">GSPrintPanel</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSTable.html#class$GSTable">GSTable</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSTheme.html#class$GSTheme">GSTheme</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/GSVbox.html#class$GSVbox">GSVbox</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSHbox.html#class$GSHbox">GSHbox</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSTheme.html#class$GSPageLayout">GSPageLayout</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSTheme.html#class$GSPrintPanel">GSPrintPanel</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSTable.html#class$GSTable">GSTable</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSTheme.html#class$GSTheme">GSTheme</a><br/>
<a rel="gsdoc" target="mainFrame" href="GSVbox.html#class$GSVbox">GSVbox</a><br/>

<br />
</font>
Expand Down
23 changes: 0 additions & 23 deletions resources/documentation/Developer/Gui/Additions/ConstantsTOC.html

This file was deleted.

90 changes: 90 additions & 0 deletions resources/documentation/Developer/Gui/Additions/Functions.gsdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="Functions" up="GuiAdditions">
<head>
<title>Functions</title>
<author name="Generated by Gregory John Casamento,,,"></author>
</head>
<body>
<front><contents /></front>
<!--StartFunctions-->
<!--StartGSDisplayServerFunctions-->
<chapter>
<heading>GSDisplayServer functions</heading>
<p></p>
<function type="void" name="DPSDiscardEvents" ovadd="1.0.0">
<arg type="GSDisplayServer*">ctxt</arg>
<arg type="unsigned int">mask</arg>
<arg type="NSEvent*">limit</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</function>
<function type="NSEvent*" name="DPSGetEvent" ovadd="1.0.0">
<arg type="GSDisplayServer*">ctxt</arg>
<arg type="unsigned int">mask</arg>
<arg type="NSDate*">limit</arg>
<arg type="NSString*">mode</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</function>
<function type="NSEvent*" name="DPSPeekEvent" ovadd="1.0.0">
<arg type="GSDisplayServer*">ctxt</arg>
<arg type="unsigned int">mask</arg>
<arg type="NSDate*">limit</arg>
<arg type="NSString*">mode</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</function>
<function type="void" name="DPSPostEvent" ovadd="1.0.0">
<arg type="GSDisplayServer*">ctxt</arg>
<arg type="NSEvent*">anEvent</arg>
<arg type="BOOL">atStart</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</function>
<function type="GSDisplayServer*" name="GSCurrentServer" ovadd="1.0.0">
<desc>
Returns the current GSDisplayServer
</desc>
</function>
<function type="GSDisplayServer*" name="GSServerForWindow" ovadd="1.0.0">
<arg type="NSWindow*">window</arg>
<desc>
Returns the GSDisplayServer that created the interal
representation for <var>window</var>. If the
internal representation has not yet been created
(for instance, if the <var>window</var> is deferred), it
returns the current server
</desc>
</function>
</chapter>
<!--EndGSDisplayServerFunctions-->
<!--StartGSThemeFunctions-->
<chapter>
<heading>GSTheme functions</heading>
<p></p>
<function type="GSThemeFillStyle" name="GSThemeFillStyleFromString" ovadd="0.0.0" ovrem="0.0.0">
<arg type="NSString*">s</arg>
<desc>
Function to convert a string to a fill style
enumeration value. <br /> Returns
GSThemeFillStyleNone if the string is
not a valid name.
</desc>
</function>
<function type="NSString*" name="GSThemeStringFromFillStyle" ovadd="0.0.0" ovrem="0.0.0">
<arg type="GSThemeFillStyle">s</arg>
<desc>
Function to convert a fill style enumeration value
to a string. <br /> Returns <code>nil</code> on failure.
</desc>
</function>
</chapter>
<!--EndGSThemeFunctions-->
<!--EndFunctions-->
</body>
</gsdoc>
18 changes: 9 additions & 9 deletions resources/documentation/Developer/Gui/Additions/Functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<h1><a name="title$Functions">Functions</a></h1>
<h3>Authors</h3>
<dl>
<dt>Generated by fedor</dt>
<dt>Generated by Gregory John Casamento,,,</dt>
<dd>
</dd>
</dl>
Expand All @@ -35,7 +35,7 @@ <h1><a name="001000000000">GSDisplayServer functions</a></h1>
<p>
</p>
<h3><a name="function$DPSDiscardEvents">DPSDiscardEvents</a></h3>
void DPSDiscardEvents(<a rel="gsdoc" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, unsigned int <b>mask</b>, NSEvent* <b>limit</b>);<br />
void DPSDiscardEvents(<a rel="gsdoc" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, unsigned int <b>mask</b>, <a rel="gsdoc" href="/usr/GNUstep/System/Library/Documentation/Developer/Gui/Reference/NSEvent.html#class$NSEvent">NSEvent</a>* <b>limit</b>);<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Expand All @@ -46,7 +46,7 @@ <h3><a name="function$DPSDiscardEvents">DPSDiscardEvents</a></h3>
</div>
<hr width="25%" align="left" />
<h3><a name="function$DPSGetEvent">DPSGetEvent</a></h3>
NSEvent* DPSGetEvent(<a rel="gsdoc" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, unsigned int <b>mask</b>, <a rel="gsdoc" href="../../Base/Reference/NSDate.html#class$NSDate">NSDate</a>* <b>limit</b>, <a rel="gsdoc" href="../../Base/Reference/NSString.html#class$NSString">NSString</a>* <b>mode</b>);<br />
<a rel="gsdoc" href="/usr/GNUstep/System/Library/Documentation/Developer/Gui/Reference/NSEvent.html#class$NSEvent">NSEvent</a>* DPSGetEvent(<a rel="gsdoc" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, unsigned int <b>mask</b>, NSDate* <b>limit</b>, NSString* <b>mode</b>);<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Expand All @@ -57,7 +57,7 @@ <h3><a name="function$DPSGetEvent">DPSGetEvent</a></h3>
</div>
<hr width="25%" align="left" />
<h3><a name="function$DPSPeekEvent">DPSPeekEvent</a></h3>
NSEvent* DPSPeekEvent(<a rel="gsdoc" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, unsigned int <b>mask</b>, <a rel="gsdoc" href="../../Base/Reference/NSDate.html#class$NSDate">NSDate</a>* <b>limit</b>, <a rel="gsdoc" href="../../Base/Reference/NSString.html#class$NSString">NSString</a>* <b>mode</b>);<br />
<a rel="gsdoc" href="/usr/GNUstep/System/Library/Documentation/Developer/Gui/Reference/NSEvent.html#class$NSEvent">NSEvent</a>* DPSPeekEvent(<a rel="gsdoc" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, unsigned int <b>mask</b>, NSDate* <b>limit</b>, NSString* <b>mode</b>);<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Expand All @@ -68,7 +68,7 @@ <h3><a name="function$DPSPeekEvent">DPSPeekEvent</a></h3>
</div>
<hr width="25%" align="left" />
<h3><a name="function$DPSPostEvent">DPSPostEvent</a></h3>
void DPSPostEvent(<a rel="gsdoc" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, NSEvent* <b>anEvent</b>, BOOL <b>atStart</b>);<br />
void DPSPostEvent(<a rel="gsdoc" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* <b>ctxt</b>, <a rel="gsdoc" href="/usr/GNUstep/System/Library/Documentation/Developer/Gui/Reference/NSEvent.html#class$NSEvent">NSEvent</a>* <b>anEvent</b>, BOOL <b>atStart</b>);<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Expand All @@ -79,7 +79,7 @@ <h3><a name="function$DPSPostEvent">DPSPostEvent</a></h3>
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSCurrentServer">GSCurrentServer</a></h3>
<a rel="gsdoc" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* GSCurrentServer();<br />
<a rel="gsdoc" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* GSCurrentServer();<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Expand All @@ -90,7 +90,7 @@ <h3><a name="function$GSCurrentServer">GSCurrentServer</a></h3>
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSServerForWindow">GSServerForWindow</a></h3>
<a rel="gsdoc" href="../../Gui/Additions/GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* GSServerForWindow(NSWindow* <b>window</b>);<br />
<a rel="gsdoc" href="GSDisplayServer.html#class$GSDisplayServer">GSDisplayServer</a>* GSServerForWindow(<a rel="gsdoc" href="/usr/GNUstep/System/Library/Documentation/Developer/Gui/Reference/NSWindow.html#class$NSWindow">NSWindow</a>* <b>window</b>);<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Expand All @@ -109,7 +109,7 @@ <h1><a name="002000000000">GSTheme functions</a></h1>
<p>
</p>
<h3><a name="function$GSThemeFillStyleFromString">GSThemeFillStyleFromString</a></h3>
<a rel="gsdoc" href="../../Gui/Additions/TypesAndConstants.html#type$GSThemeFillStyle">GSThemeFillStyle</a> GSThemeFillStyleFromString(<a rel="gsdoc" href="../../Base/Reference/NSString.html#class$NSString">NSString</a>* <b>s</b>);<br />
<a rel="gsdoc" href="TypesAndConstants.html#type$GSThemeFillStyle">GSThemeFillStyle</a> GSThemeFillStyleFromString(NSString* <b>s</b>);<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
Expand All @@ -123,7 +123,7 @@ <h3><a name="function$GSThemeFillStyleFromString">GSThemeFillStyleFromString</a>
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSThemeStringFromFillStyle">GSThemeStringFromFillStyle</a></h3>
<a rel="gsdoc" href="../../Base/Reference/NSString.html#class$NSString">NSString</a>* GSThemeStringFromFillStyle(<a rel="gsdoc" href="../../Gui/Additions/TypesAndConstants.html#type$GSThemeFillStyle">GSThemeFillStyle</a> <b>s</b>);<br />
NSString* GSThemeStringFromFillStyle(<a rel="gsdoc" href="TypesAndConstants.html#type$GSThemeFillStyle">GSThemeFillStyle</a> <b>s</b>);<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
Expand Down
13 changes: 13 additions & 0 deletions resources/documentation/Developer/Gui/Additions/FunctionsTOC.gsdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="Functions" stylesheeturl="gsdoc_contents">
<head>
<title>Functions</title>
</head>
<body>
<chapter>
<index type="function" scope="project" target="mainFrame"
style="bare" />
</chapter>
</body>
</gsdoc>
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ <h2><a name="title$Functions">Functions</a></h2>



<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$DPSDiscardEvents">DPSDiscardEvents</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$DPSGetEvent">DPSGetEvent</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$DPSPeekEvent">DPSPeekEvent</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$DPSPostEvent">DPSPostEvent</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$GSCurrentServer">GSCurrentServer</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$GSServerForWindow">GSServerForWindow</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$GSThemeFillStyleFromString">GSThemeFillStyleFromString</a><br/>
<a rel="gsdoc" target="mainFrame" href="../../Gui/Additions/Functions.html#function$GSThemeStringFromFillStyle">GSThemeStringFromFillStyle</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$DPSDiscardEvents">DPSDiscardEvents</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$DPSGetEvent">DPSGetEvent</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$DPSPeekEvent">DPSPeekEvent</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$DPSPostEvent">DPSPostEvent</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$GSCurrentServer">GSCurrentServer</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$GSServerForWindow">GSServerForWindow</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$GSThemeFillStyleFromString">GSThemeFillStyleFromString</a><br/>
<a rel="gsdoc" target="mainFrame" href="Functions.html#function$GSThemeStringFromFillStyle">GSThemeStringFromFillStyle</a><br/>

<br />
</font>
Expand Down
Loading

0 comments on commit 8aee10d

Please sign in to comment.