Skip to content

Commit 4c3a7cb

Browse files
Fixed documentation.
1 parent bfcd47f commit 4c3a7cb

File tree

2 files changed

+55
-16
lines changed

2 files changed

+55
-16
lines changed

ugbc/src/targets/common/begin_storage.c

Lines changed: 55 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@
4545
* @param _name Name of the storage
4646
*/
4747
/* <usermanual>
48-
@keyword BEGIN STORAGE
48+
@keyword BEGIN STORAGE...END STORAGE
4949
5050
@english
5151
52-
The ''BEGIN STORAGE'' allows to begin describing
52+
The ''BEGIN STORAGE..END STORAGE'' allows to begin describing
5353
the content of a storage media. The syntax of this command
5454
allows to define up to two parameter. The first parameter,
5555
''name'', refers to the internal name of the storage.
@@ -58,6 +58,20 @@ that will contain the "image" of the storage. If omitted,
5858
the program filename will be used, and an additional incremented
5959
number will be appended, one for each storage media.
6060
61+
Note that, for some targets, a special toolchain is needed to
62+
manage this keyword. In particular, for ''cpc'' target you need to
63+
install and use the correct version of the ''z88dk-appmake'' application.
64+
Starting from version 1.15.3 of ugBASIC, that is, since
65+
''BEGIN STORAGE'' was implemented for ''cpc'', it is necessary to use a
66+
patched version of the z88dk toolchain. The version that can be
67+
obtained from the official release is not powerful enough to include
68+
external files in the disk image that is created for that target.
69+
70+
You can find out the empowered version looking for a fork of that project,
71+
or as a module inside ugBASIC. You should recompile it on a specific branch
72+
(''ugbasic'' branch, precisely). On ugBASIC website and on the UGBASIC-IDE
73+
there is a precompiled version from that version, that can be directly
74+
used.
6175
6276
@italian
6377
Il comando ''BEGIN STORAGE'' consente di iniziare a descrivere
@@ -71,20 +85,55 @@ nome del file del programma e verrà aggiunto un numero
7185
incrementato aggiuntivo, uno per ciascun supporto di
7286
memorizzazione.
7387
74-
@syntax BEGIN STORAGE [name] [AS filename]
75-
@syntax STORAGE [name] [AS filename]
88+
Nota che per alcuni target è necessaria una toolchain speciale per
89+
gestire questa parola chiave. In particolare, per il target ''cpc'' devi
90+
installare e usare la versione corretta dell'applicazione ''z88dk-appmake''.
91+
A partire dalla versione 1.15.3 di ugBASIC, ovvero, poiché
92+
''BEGIN STORAGE'' è stato implementato per ''cpc'', si deve usare una
93+
versione patchata della toolchain z88dk. La versione che può essere
94+
ottenuta dalla release ufficiale non è abbastanza potente da includere
95+
file esterni nell'immagine disco creata per quel target.
96+
97+
E' possibile trovare la versione migliorata cercando un fork di quel progetto,
98+
o come modulo all'interno di ugBASIC. Dovresti ricompilarla su un ramo specifico
99+
(ramo ''ugbasic'', per essere precisi). Sul sito web di ugBASIC e in UGBASIC-IDE
100+
c'è una versione precompilata di quella versione, che può essere
101+
utilizzata direttamente.
102+
103+
@syntax BEGIN STORAGE name [AS filename] ... END STORAGE
104+
@syntax STORAGE name [AS filename] ... END STORAGE
76105
77106
@example BEGIN STORAGE "dischetto"
78107
@example ...
79108
@example ENDSTORAGE
80109
81110
@usedInExample storage_example_01.bas
82111
83-
@alias STORAGE
84-
@seeAlso ENDSTORAGE
112+
@alias STORAGE...END STORAGE
85113
86114
@target atari c128 c64 c64reu coco coco3 cpc msx1 vic20
87115
</usermanual> */
116+
/* <usermanual>
117+
@keyword STORAGE...END STORAGE
118+
119+
@english
120+
121+
@italian
122+
123+
@syntax STORAGE name [AS filename] .. END STORAGE
124+
@syntax STORAGE name [AS filename] .. END STORAGE
125+
126+
@example BEGIN STORAGE "dischetto"
127+
@example ...
128+
@example ENDSTORAGE
129+
130+
@usedInExample storage_example_01.bas
131+
132+
@alias BEGIN STORAGE...END STORAGE
133+
134+
@target atari c128 c64 c64reu coco coco3 cpc msx1 vic20
135+
</usermanual> */
136+
88137
void begin_storage( Environment * _environment, char * _name, char * _file_name ) {
89138

90139
if ( _environment->currentStorage ) {

ugbc/src/targets/common/end_storage.c

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,6 @@
4444
* @param _environment Current calling environment
4545
* @param _value Value to the return
4646
*/
47-
/* <usermanual>
48-
@keyword STORAGE...ENDSTORAGE
49-
50-
@english
51-
To conclude the definition of a mass memory, the ENDSTORAGE command can be used.
52-
53-
@italian
54-
Per concludere la definizione di una memoria di massa si può utilizzare il comando ENDSTORAGE.
55-
56-
</usermanual> */
5747
void end_storage( Environment * _environment ) {
5848

5949
if ( ! _environment->currentStorage ) {

0 commit comments

Comments
 (0)