doxygen compatible (cleaned) but severe modif in graphics doc (init, draw, grid) - graphics_set_arrow() fixed
This commit is contained in:
parent
12e06f3aa4
commit
31e8e0b2e2
GPG Key ID:
FB3115C340E057E3
|
|
@ -101,6 +101,10 @@
|
|||
<para>Writes grid lines on space faces. </para>
|
||||
</listitem>
|
||||
<listitem><para>long <link linkend="_graphics_8h_1a4b522c9dc5b1ba15444956adb1c08cf5">graphics_draw_grids_on_space_faces_lines</link> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
|
||||
</listitem>
|
||||
<listitem><para>int <link linkend="_graphics_8h_1a6a8069bea50642d8e4d582194cf7c014">graphics_set_arrow</link> (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)</para>
|
||||
|
||||
<para>phantom documentation </para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</simplesect>
|
||||
|
|
@ -727,6 +731,82 @@ Parameters</title>
|
|||
</formalpara>
|
||||
</para>
|
||||
</section>
|
||||
<anchor xml:id="_graphics_8h_1a6a8069bea50642d8e4d582194cf7c014"/><section>
|
||||
<title>graphics_set_arrow()</title>
|
||||
<indexterm><primary>graphics_set_arrow</primary><secondary>graphics.h</secondary></indexterm>
|
||||
<indexterm><primary>graphics.h</primary><secondary>graphics_set_arrow</secondary></indexterm>
|
||||
<para><computeroutput>int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)</computeroutput></para><para>
|
||||
|
||||
<para>phantom documentation </para>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<formalpara>
|
||||
<title>
|
||||
Parameters</title>
|
||||
<para>
|
||||
<table frame="all">
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
<colspec colwidth="1*"/>
|
||||
<colspec colwidth="4*"/>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>graphics_stack_id</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>arrows_nb</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>space_X</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>space_Y</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>space_Z</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>requested_weight</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>site</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>arrow_x</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>arrow_y</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>arrow_z</entry><entry>
|
||||
<para></para>
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
</formalpara>
|
||||
</para>
|
||||
</section>
|
||||
<anchor xml:id="_graphics_8h_1aa4d80f7ee104aa414e7ed4b90e0eac88"/><section>
|
||||
<title>graphics_shutdown()</title>
|
||||
<indexterm><primary>graphics_shutdown</primary><secondary>graphics.h</secondary></indexterm>
|
||||
|
|
|
|||
|
|
@ -108,6 +108,10 @@ include/graphics.h \- graphics header
|
|||
.ti -1c
|
||||
.RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "int \fBgraphics_set_arrow\fP (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)"
|
||||
.br
|
||||
.RI "phantom documentation "
|
||||
.in -1c
|
||||
.SS "Variables"
|
||||
|
||||
|
|
@ -380,6 +384,35 @@ graphics_model_setup
|
|||
.RE
|
||||
.PP
|
||||
|
||||
.SS "int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)"
|
||||
|
||||
.PP
|
||||
phantom documentation
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIgraphics_stack_id\fP
|
||||
.br
|
||||
\fIarrows_nb\fP
|
||||
.br
|
||||
\fIspace_X\fP
|
||||
.br
|
||||
\fIspace_Y\fP
|
||||
.br
|
||||
\fIspace_Z\fP
|
||||
.br
|
||||
\fIrequested_weight\fP
|
||||
.br
|
||||
\fIsite\fP
|
||||
.br
|
||||
\fIarrow_x\fP
|
||||
.br
|
||||
\fIarrow_y\fP
|
||||
.br
|
||||
\fIarrow_z\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "bool graphics_shutdown (const int id, void * error_buffer)"
|
||||
|
||||
.PP
|
||||
|
|
|
|||
|
|
@ -309,7 +309,19 @@ long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id,
|
|||
long y,
|
||||
long z);
|
||||
|
||||
/*
|
||||
/** phantom documentation
|
||||
*
|
||||
* @param graphics_stack_id
|
||||
* @param arrows_nb
|
||||
* @param space_X
|
||||
* @param space_Y
|
||||
* @param space_Z
|
||||
* @param requested_weight
|
||||
* @param site
|
||||
* @param arrow_x
|
||||
* @param arrow_y
|
||||
* @param arrow_z
|
||||
*/
|
||||
int graphics_set_arrow (
|
||||
int graphics_stack_id,
|
||||
int arrows_nb,
|
||||
|
|
@ -322,4 +334,4 @@ int graphics_set_arrow (
|
|||
int arrow_y,
|
||||
int arrow_z
|
||||
);
|
||||
*/
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue