Fixed manual.

spotlessmind1975 · Oct 11, 2023 · 29929f3 · 29929f3
1 parent 9c7f844
commit 29929f3
Show file tree

Hide file tree

Showing 96 changed files with 94 additions and 1,017 deletions.
diff --git a/ugbc/src/targets/atari/paper.c b/ugbc/src/targets/atari/paper.c
@@ -44,10 +44,6 @@
  * @param _environment Current calling environment
  * @param _color Color to use for the paper
  */
-/* <usermanual>
-@keyword PAPER
-@target atari
-</usermanual> */
 void paper( Environment * _environment, char * _color ) {
 
     Variable * paper = variable_retrieve( _environment, "PAPER" );

diff --git a/ugbc/src/targets/atari/play.c b/ugbc/src/targets/atari/play.c
@@ -68,7 +68,7 @@ dal comando ''VOICES''/''CHANNELS''). Poi è possibile omettere la durata, e in
 continuerà ad essere suonato mentre viene eseguita l'istruzione successiva. La durata è
 espressa in millisecondi.
 
-@syntax PLAY #[note] {, #[duration] {ON #[channels]}}
+@syntax PLAY #note[, #duration] [ON #channels]
 
 @example PLAY #32
 @example PLAY #24, #250
@@ -100,7 +100,7 @@ void play( Environment * _environment, int _note, int _delay, int _channels ) {
 /* <usermanual>
 @keyword PLAY
 
-@syntax PLAY [note] {, [duration] {ON [channels]}}
+@syntax PLAY note[, duration] [ON channels]
 
 @example PLAY laDiesis
 @example PLAY solMaggiore, breve

diff --git a/ugbc/src/targets/atari/play_off.c b/ugbc/src/targets/atari/play_off.c
@@ -55,7 +55,7 @@ This command allows you to stop the play on all channels or specific channels.
 @italian
 Questo comando permette di interrompere il suono su tutti i canali o su canali specifici.
 
-@syntax PLAY OFF {ON #channels}
+@syntax PLAY OFF [ON #channels]
 
 @example PLAY OFF
 @example PLAY OFF ON #%001
@@ -79,7 +79,7 @@ void play_off( Environment * _environment, int _channels ) {
 /* <usermanual>
 @keyword PLAY OFF
 
-@syntax PLAY OFF {ON [channels]}
+@syntax PLAY OFF [ON channels]
 
 @example PLAY OFF
 @example PLAY OFF ON primaVoce

diff --git a/ugbc/src/targets/atari/point_at.c b/ugbc/src/targets/atari/point_at.c
@@ -51,10 +51,6 @@
  * @param _y Ordinate of the point
  * @throw EXIT_FAILURE "CRITICAL: POINT AT (xxx,xxx) needs BITMAP ENABLE"
  */
-/* <usermanual>
-@keyword POINT AT
-@target atari
-</usermanual> */
 void point_at( Environment * _environment, int _x, int _y ) {
 
     outline2("; POINT AT (%d,%d)", _x, _y);
@@ -81,9 +77,6 @@ void point_at( Environment * _environment, int _x, int _y ) {
  * @param _y Expression with the ordinate of the point
  * @throw EXIT_FAILURE "CRITICAL: POINT AT (xxx,xxx) needs BITMAP ENABLE"
  */
-/* <usermanual>
-@keyword POINT AT
-</usermanual> */
 void point_at_vars( Environment * _environment, char * _x, char * _y ) {
 
     outline2("; POINT AT (%s,%s)", _x, _y);

diff --git a/ugbc/src/targets/c128/next_raster_at.c b/ugbc/src/targets/c128/next_raster_at.c
@@ -64,7 +64,7 @@ ed esegui il codice in corrispondenza dell'etichetta data. Nel
 frattempo, l'esecuzione del codice principale riprenderà da dove 
 era stata interrotta.
 
-@syntax NEXT RASTER AT # [integer] WITH [label]
+@syntax NEXT RASTER AT #line WITH label
 
 @example NEXT RASTER AT #$42 WITH myRasterRoutine
 
@@ -96,7 +96,7 @@ void next_raster_at_with( Environment * _environment, int _position, char * _lab
 /* <usermanual>
 @keyword NEXT RASTER AT
 
-@syntax NEXT RASTER AT [expression] WITH [label]
+@syntax NEXT RASTER AT expression WITH label
 
 @example NEXT RASTER AT newRaterLine WITH myRasterRoutine
 </usermanual> */

diff --git a/ugbc/src/targets/c128/paper.c b/ugbc/src/targets/c128/paper.c
@@ -62,7 +62,7 @@ un numero compreso tra 0 e ''PAPER COLORS'', a seconda della
 modalità grafica in uso, esattamente come ''PEN''. Il colore
 predefinito è ''DEFAULT PAPER''.
 
-@syntax PAPER [expression]
+@syntax PAPER expression
 
 @example PAPER 4
 @example PAPER (esempio)

diff --git a/ugbc/src/targets/c128/play.c b/ugbc/src/targets/c128/play.c
@@ -51,29 +51,6 @@
  */
 /* <usermanual>
 @keyword PLAY
-
-@english
-This command allows you to play a certain note, for a certain time and on certain 
-channels. The command has a number of variations. First, you can omit the channel. 
-In this case, the sound will be played on all channels (or on those enabled by the 
-''VOICES''/''CHANNELS'' command). Then you can omit the duration, in which case the sound will 
-continue to play while the next instruction is executed. Duration is expressed
-in milliseconds.
-
-@italian
-Questo comando permette di suonare una certa nota, per un certo tempo e su certi 
-canali. Il comando ha una serie di varianti. In primo luogo, è possibile omettere il 
-canale. In tal caso, il suono sarà suonato su tutti i canali (oppure su quelli abilitati 
-dal comando ''VOICES''/''CHANNELS''). Poi è possibile omettere la durata, e in tal caso il suono 
-continuerà ad essere suonato mentre viene eseguita l'istruzione successiva. La durata è
-espressa in millisecondi.
-
-@syntax PLAY #[note] {, #[duration] {ON #[channels]}}
-
-@example PLAY #32
-@example PLAY #24, #250
-@example PLAY #60, #1250 ON #%001
-
 @target c128
 </usermanual> */
 void play( Environment * _environment, int _note, int _delay, int _channels ) {
@@ -99,13 +76,6 @@ void play( Environment * _environment, int _note, int _delay, int _channels ) {
  */
 /* <usermanual>
 @keyword PLAY
-
-@syntax PLAY [note] {, [duration] {ON [channels]}}
-
-@example PLAY laDiesis
-@example PLAY solMaggiore, breve
-@example PLAY solMaggiore, lunga ON primaVoce
-
 @target c128
 </usermanual> */
 void play_vars( Environment * _environment, char * _note, char * _delay, char * _channels ) {

diff --git a/ugbc/src/targets/c128/play_off.c b/ugbc/src/targets/c128/play_off.c
@@ -48,18 +48,6 @@
  */
 /* <usermanual>
 @keyword PLAY OFF
-
-@english
-This command allows you to stop the play on all channels or specific channels.
-
-@italian
-Questo comando permette di interrompere il suono su tutti i canali o su canali specifici.
-
-@syntax PLAY OFF {ON #channels}
-
-@example PLAY OFF
-@example PLAY OFF ON #%001
-
 @target c128
 </usermanual> */
 void play_off( Environment * _environment, int _channels ) {
@@ -78,12 +66,6 @@ void play_off( Environment * _environment, int _channels ) {
  */
 /* <usermanual>
 @keyword PLAY OFF
-
-@syntax PLAY OFF {ON [channels]}
-
-@example PLAY OFF
-@example PLAY OFF ON primaVoce
-
 @target c128
 </usermanual> */
 void play_off_var( Environment * _environment, char * _channels ) {

diff --git a/ugbc/src/targets/c128/plot.c b/ugbc/src/targets/c128/plot.c
@@ -67,7 +67,7 @@ il colore di default è quello impostato con l'ultimo comando ''INK'' / ''PEN''.
 E' possibile omettere una o entrambe le coordinate, e ugBASIC utilizzerà l'ultima 
 usata, che viene stoccata nelle variabili ''XGR'' e ''YGR''.
 
-@syntax PLOT [x], [y] {, [color]}
+@syntax PLOT [x], [y][, color
 
 @example PLOT 42, 42
 @example PLOT 100, 100, RED

diff --git a/ugbc/src/targets/c128/point_at.c b/ugbc/src/targets/c128/point_at.c
@@ -55,17 +55,25 @@
 @keyword POINT AT
 
 @english
-Draws a pixel on the screen in bitmap mode on given coordinates. 
+The ''POINT AT'' instruction allows you to draw a point on the screen, at 
+the ''(x, y)'' coordinate. The color is the default color, the one set with 
+the last ''INK'' / ''PEN'' command.
 
 @italian
-Disegna un pixel sullo schermo in modalità bitmap su coordinate date.
+L'istruzione ''POINT AT'' permette di tracciare un punto sullo schermo, a
+la coordinata ''(x, y)''. Il colore è quello predefinito, quello impostato con
+l'ultimo comando ''INK'' / ''PEN''.
 
-@syntax POINT AT (# [integer], # [integer])
+@syntax POINT AT(#x, #y)
+@syntax POINT AT(x, y)
 
-@example POINT AT (#42,#42)
+@example POINT AT (42, 42)
+@example POINT AT (100, 100)
+@example POINT AT (x+1,y+1)
 
 @target c128
-</usermanual> */
+ </usermanual> */
+
 void point_at( Environment * _environment, int _x, int _y ) {
 
     outline2("; POINT AT (%d,%d)", _x, _y);
@@ -92,13 +100,6 @@ void point_at( Environment * _environment, int _x, int _y ) {
  * @param _y Expression with the ordinate of the point
  * @throw EXIT_FAILURE "CRITICAL: POINT AT (xxx,xxx) needs BITMAP ENABLE"
  */
-/* <usermanual>
-@keyword POINT AT
-
-@syntax POINT AT ([expression],[expression])
-
-@example POINT AT (x+1,y+1)
-</usermanual> */
 void point_at_vars( Environment * _environment, char * _x, char * _y ) {
 
     outline2("; POINT AT (%s,%s)", _x, _y);

diff --git a/ugbc/src/targets/c128/text_get_paper.c b/ugbc/src/targets/c128/text_get_paper.c
@@ -46,10 +46,10 @@
  * @return Variable* 
  */
 /* <usermanual>
-@keyword PAPER$
+@keyword PAPER (function)
 
 @english
-The ''PEN$'' function returns a special control sequence that changes
+The ''PAPER$'' function returns a special control sequence that changes
 the paper colour inside a string. This means that, whenever the string is 
 printed on the screen, the pre-set paper colour is automatically assigned 
 to it. The format of the string returned by ''PAPER$'' is not specific 
@@ -63,7 +63,7 @@ sullo schermo, le viene automaticamente assegnato il colore
 dello sfondo preimpostato. Il formato della stringa restituita da
 ''PAPER$'' non è specifico per l'hardware
 
-@syntax = PAPER$([expression])
+@syntax = PAPER$(expression)
 
 @example PRINT PAPER$(WHITE)
 

diff --git a/ugbc/src/targets/c128z/paper.c b/ugbc/src/targets/c128z/paper.c
@@ -43,11 +43,6 @@
  * @param _environment Current calling environment
  * @param _color Color to use for the paper
  */
-/* <usermanual>
-@keyword PAPER
-
-@target c128z
-</usermanual> */
 void paper( Environment * _environment, char * _color ) {
 
     Variable * paper = variable_retrieve( _environment, "PAPER" );

diff --git a/ugbc/src/targets/c128z/play.c b/ugbc/src/targets/c128z/play.c
@@ -51,30 +51,6 @@
  */
 /* <usermanual>
 @keyword PLAY
-
-@english
-This command allows you to play a certain note, for a certain time and on certain 
-channels. The command has a number of variations. First, you can omit the channel. 
-In this case, the sound will be played on all channels (or on those enabled by the 
-''VOICES''/''CHANNELS'' command). Then you can omit the duration, in which case the sound will 
-continue to play while the next instruction is executed. Duration is expressed
-in milliseconds.
-
-@italian
-Questo comando permette di suonare una certa nota, per un certo tempo e su certi 
-canali. Il comando ha una serie di varianti. In primo luogo, è possibile omettere il 
-canale. In tal caso, il suono sarà suonato su tutti i canali (oppure su quelli abilitati 
-dal comando ''VOICES''/''CHANNELS''). Poi è possibile omettere la durata, e in tal caso il suono 
-continuerà ad essere suonato mentre viene eseguita l'istruzione successiva. La durata è
-espressa in millisecondi.
-
-@syntax PLAY #[note] {, #[duration] {ON #[channels]}}
-
-@example PLAY #32
-@example PLAY #24, #250
-@example PLAY #60, #1250 ON #%001
-
-@target c128z
 </usermanual> */
 void play( Environment * _environment, int _note, int _delay, int _channels ) {
 
@@ -99,14 +75,6 @@ void play( Environment * _environment, int _note, int _delay, int _channels ) {
  */
 /* <usermanual>
 @keyword PLAY
-
-@syntax PLAY [note] {, [duration] {ON [channels]}}
-
-@example PLAY laDiesis
-@example PLAY solMaggiore, breve
-@example PLAY solMaggiore, lunga ON primaVoce
-
-@target c128z
 </usermanual> */
 void play_vars( Environment * _environment, char * _note, char * _delay, char * _channels ) {
 

diff --git a/ugbc/src/targets/c128z/play_off.c b/ugbc/src/targets/c128z/play_off.c
@@ -48,19 +48,6 @@
  */
 /* <usermanual>
 @keyword PLAY OFF
-
-@english
-This command allows you to stop the play on all channels or specific channels.
-
-@italian
-Questo comando permette di interrompere il suono su tutti i canali o su canali specifici.
-
-@syntax PLAY OFF {ON #channels}
-
-@example PLAY OFF
-@example PLAY OFF ON #%001
-
-@target c128z
 </usermanual> */
 void play_off( Environment * _environment, int _channels ) {
 
@@ -78,13 +65,6 @@ void play_off( Environment * _environment, int _channels ) {
  */
 /* <usermanual>
 @keyword PLAY OFF
-
-@syntax PLAY OFF {ON [channels]}
-
-@example PLAY OFF
-@example PLAY OFF ON primaVoce
-
-@target c128z
 </usermanual> */
 void play_off_var( Environment * _environment, char * _channels ) {
 

diff --git a/ugbc/src/targets/c128z/point_at.c b/ugbc/src/targets/c128z/point_at.c
@@ -54,11 +54,6 @@
  * @param _y Ordinate of the point
  * @throw EXIT_FAILURE "CRITICAL: POINT AT (xxx,xxx) needs BITMAP ENABLE"
  */
-/* <usermanual>
-@keyword POINT AT
-
-@target c128z
-</usermanual> */
 void point_at( Environment * _environment, int _x, int _y ) {
 
     vdcz_point_at_int( _environment, _x, _y );

diff --git a/ugbc/src/targets/c64/next_raster_at.c b/ugbc/src/targets/c64/next_raster_at.c
@@ -52,22 +52,6 @@
  */
 /* <usermanual>
 @keyword NEXT RASTER AT
-
-@english
-Wait for the next raster at a specific, new, raster position
-and to execute the code at the given label. Meanwhile, the 
-execution of the main code will resume where it left off.
-
-@italian
-Attendi il raster successivo in una nuova posizione raster specifica
-ed esegui il codice in corrispondenza dell'etichetta data. Nel 
-frattempo, l'esecuzione del codice principale riprenderà da dove 
-era stata interrotta.
-
-@syntax NEXT RASTER AT # [integer] WITH [label]
-
-@example NEXT RASTER AT #$42 WITH myRasterRoutine
-
 @target c64
 </usermanual> */
 void next_raster_at_with( Environment * _environment, int _position, char * _label ) {
@@ -95,10 +79,6 @@ void next_raster_at_with( Environment * _environment, int _position, char * _lab
  */
 /* <usermanual>
 @keyword NEXT RASTER AT
-
-@syntax NEXT RASTER AT [expression] WITH [label]
-
-@example NEXT RASTER AT newRaterLine WITH myRasterRoutine
 </usermanual> */
 void next_raster_at_with_var( Environment * _environment, char * _position, char * _label ) {