Skip to content

Commit

Permalink
Merge pull request #559 from SuperDARN/fix_broken_doc_links
Browse files Browse the repository at this point in the history
Fixing broken HTML documentation links
  • Loading branch information
ksterne authored Jun 11, 2024
2 parents 78a55cc + b5016cd commit f3891b4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions codebase/general/src.lib/evallib.1.4/doc/eval.doc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<library>
<project>general</project>
<name>reval</name>
<location>src.lib/eval</location>
<location>src.lib/evallib</location>
<function>
<name>Eval</name>
<location>src.lib/eval</location>
<location>src.lib/evallib</location>
<header>general/reval.h</header>
<syntax>int Eval(char *sum,double *ptr,int (*dvar)(char *ptr,double *val,void *data),void *vdata,int (*dfun)(char *ptr,int argnum,double *argptr,double *val,void *data),void *fdata);</syntax>
<description><p>The <fn href="Eval.html">Eval</fn> function evaluates a mathematical expression.</p>
Expand Down
4 changes: 2 additions & 2 deletions codebase/general/src.lib/map.1.18/doc/map.doc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
<name>MapPlotOpenPolygon</name>
<location>src.lib/map</location>
<header>general/rmap.h</header>
<syntax>void MapPlotOpenPolygon(<sn href="&root;/src.lib/base/graphic/rplot/structRplot.html">struct Rplot</sn> *rplot,<sn href="&root;/src.lib/base/graphic/rplot/structRplotMatrix.html">struct RplotMatrix</sn> *matrix, float x,float y,float w,float h, unsigned int color,unsigned char mask, float width,<sn href="&root;/src.lib/base/graphic/rplot/structRplotDash.html">struct RplotDash</sn> *dash, <sn href="&root;/general/src.lib/polygon/structPolygonData.html">struct PolygonData</sn> *poly,int type);</syntax>
<syntax>void MapPlotOpenPolygon(struct Rplot *rplot,struct RplotMatrix *matrix, float x,float y,float w,float h, unsigned int color,unsigned char mask, float width,struct RplotDash *dash, <sn href="&root;/general/src.lib/polygon/structPolygonData.html">struct PolygonData</sn> *poly,int type);</syntax>
<description><p>The <fn href="MapPlotOpenPolygon.html">MapPlotOpenPolygon</fn> function plots sets of polygons whose last vertex is not identical to the first vertex, making them open polygons.</p>
<p>The argument <ar>rplot</ar> is a pointer to the <code>Rplot</code> control structure that handles the plotting. The argument <ar>matrix</ar> is an optional transformation matrix that can be applied to the polygons. If this is set to a <code>NULL</code> pointer then no transformation is applied. The position at which the polygons are plotted and the size of the plot are given by the arguments <ar>x</ar>, <ar>y</ar>, <ar>w</ar> and <ar>h</ar>. The coordinates of the polygons data are assumed to be normalized between zero and (1). The x-coordinate is multiplied by <ar>w</ar> and the y-coordinate by <ar>h</ar> and then offset given by <ar>x</ar> and <ar>y</ar> are applied.</p>
<p>The color used to plot the polygon is given by the <ar>color</ar> which is a 32-bit number that represents the alpha,red,green and blue components of the color as 8-bit number. The alpha channel occupies the most significant bits and the blue channel occupies the least significant bits. The argument <ar>mask</ar> defines which color channels are active. Setting this argument to 0x0f will output the color to all four channels. The most significant bit controls the alpha channel and the least significant bit controls the blue channel.</p>
Expand All @@ -128,7 +128,7 @@
<name>MapPlotPolygon</name>
<location>src.lib/map</location>
<header>general/rmap.h</header>
<syntax>void MapPlotPolygon(<sn href="&root;/src.lib/base/graphic/rplot/structRplot.html">struct Rplot</sn> *rplot,<sn href="&root;/src.lib/base/graphic/rplot/structRplotMatrix.html">struct RplotMatrix</sn> *matrix, float x,float y,float w,float h,int fill, unsigned int color,unsigned char mask, float width,<sn href="&root;/src.lib/base/graphic/rplot/structRplotDash.html">struct RplotDash</sn> *dash, <sn href="&root;/general/src.lib/polygon/structPolygonData.html">struct PolygonData</sn> *poly,int type);</syntax>
<syntax>void MapPlotPolygon(struct Rplot *rplot,struct RplotMatrix *matrix, float x,float y,float w,float h,int fill, unsigned int color,unsigned char mask, float width,struct RplotDash *dash, <sn href="&root;/general/src.lib/polygon/structPolygonData.html">struct PolygonData</sn> *poly,int type);</syntax>
<description><p>The <fn href="MapPlotPolygon.html">MapPlotPolygon</fn> function plots sets of polygons.</p>
<p>The argument <ar>rplot</ar> is a pointer to the <code>Rplot</code> control structure that handles the plotting. The argument <ar>matrix</ar> is an optional transformation matrix that can be applied to the polygons. If this is set to a <code>NULL</code> pointer then no transformation is applied. The position at which the polygons are plotted and the size of the plot are given by the arguments <ar>x</ar>, <ar>y</ar>, <ar>w</ar> and <ar>h</ar>. The coordinates of the polygons data are assumed to be normalized between zero and (1). The x-coordinate is multiplied by <ar>w</ar> and the y-coordinate by <ar>h</ar> and then offset given by <ar>x</ar> and <ar>y</ar> are applied.</p>
<p>If the argument <ar>fill</ar> is set to a non-zero value then the polygons will be plotted as solid shapes, not outlines.</p>
Expand Down
4 changes: 2 additions & 2 deletions codebase/superdarn/src.doc/rfc/0011.rfc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ rplot -ps plot.rp.xml &gt; &gt; plot.ps</pre></td>
<p>When writing data, the application provides a pointer to a function that when supplied a memory pointer to a buffer and a size in bytes will write out the buffer to the correct destination.</p>
<h3>Writing a Producer</h3>

<p>The <a href="../src.lib/base/graphic/rplot/"><code>rplot</code></a> library
<p>The <code>rplot</code> library
is the programming interface for writing a producer. An application using this library calls functions that generate rPlot primitives. Below is a simple example of a program using the library:</p>
<center>
<table width="60%" cellspacing="3" bgcolor="e0e0e0">
Expand Down Expand Up @@ -74,7 +74,7 @@ int main(int argc,char *argv[]) {
</center>
<p>The program first establishes a data structure to store plot parameters in by calling <code>RplotMake</code>. Next the program calls <code>RplotSetText</code> to tell the <code>Rplot</code> library that it should use the application supplied function <code>stream</code> to write the output. Then the plot is started by calling <code>RplotMakePlot</code>. A simple ellipse and some text are then plotted and then finally a call to <code>RplotEndPlot</code> closes the plot.</p>
<h3>Writing a Consumer (Renderer)</h3>
<p>Writing a Consumer or Renderer is slightly more complex. The Consumer must parse the XML and then, depending on the desired output, call a function in one of the graphics rendering libraries. The <a href="../../../base/src.lib/xml/xml/"><code>xml</code></a> library is used to parse the XML. The library extract XML tag pairs and any associated content and passes them onto an application supplied function that decodes them. The <a href="../src.lib/base/graphic/rplotin/"><code>rplotin</code></a> library provides such a decoding function for the rPlot graphics specification.</p>
<p>Writing a Consumer or Renderer is slightly more complex. The Consumer must parse the XML and then, depending on the desired output, call a function in one of the graphics rendering libraries. The <a href="../../../base/src.lib/xml/xml/index.html"><code>xml</code></a> library is used to parse the XML. The library extract XML tag pairs and any associated content and passes them onto an application supplied function that decodes them. The <code>rplotin</code> library provides such a decoding function for the rPlot graphics specification.</p>
<p>Below is a simple Renderer that is partially implemented for clarity:</p>
<center>
<table width="60%" cellspacing="3" bgcolor="e0e0e0">
Expand Down

0 comments on commit f3891b4

Please sign in to comment.