Merge pull request #588 from polluks/master

Cleanup notes
This commit is contained in:
Oliver Schmidt 2018-02-10 00:35:14 +00:00 committed by GitHub
commit 4f3b47c3d7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -3469,9 +3469,6 @@ returns one of the constants<itemize>
It allows to access the current device with the <ref id="dio.h" It allows to access the current device with the <ref id="dio.h"
name="Low-level disk I/O API"> or <ref id="cbm.h" name="cbm_* I/O name="Low-level disk I/O API"> or <ref id="cbm.h" name="cbm_* I/O
functions"> requiring a 'device' parameter. functions"> requiring a 'device' parameter.
<tag/Notes/<itemize>
<item>
</itemize>
<tag/Availability/cc65 <tag/Availability/cc65
<tag/See also/ <tag/See also/
<ref id="getdevicedir" name="getdevicedir">, <ref id="getdevicedir" name="getdevicedir">,
@ -3513,6 +3510,8 @@ be used in presence of a prototype.
It allows to access the device on filesystem level by calling chdir() with It allows to access the device on filesystem level by calling chdir() with
the directory returned. the directory returned.
<tag/Notes/<itemize> <tag/Notes/<itemize>
<item>Calling getdevicedir() <em/does/ check for a (formatted) disk in a
floppy-disk-type device and returns NULL if that check fails.
<item>The function is only available as fastcall function, so it may only <item>The function is only available as fastcall function, so it may only
be used in presence of a prototype. be used in presence of a prototype.
</itemize> </itemize>
@ -3525,6 +3524,7 @@ be used in presence of a prototype.
<tag/Example/<verb> <tag/Example/<verb>
chdir (getdevicedir (device, buf, sizeof buf)); chdir (getdevicedir (device, buf, sizeof buf));
</verb> </verb>
cf. <tt/samples/enumdevdir.c/
</descrip> </descrip>
</quote> </quote>
@ -3562,7 +3562,8 @@ be used in presence of a prototype.
<tag/Description/The function returns the first device. <tag/Description/The function returns the first device.
The constant <tt/INVALID_DEVICE/ indicates no device. The constant <tt/INVALID_DEVICE/ indicates no device.
<tag/Notes/<itemize> <tag/Notes/<itemize>
<item> <item>Calling getfirstdevice() does <em/not/ turn on the motor of a
drive-type device and does <em/not/ check for a disk in the drive.
</itemize> </itemize>
<tag/Availability/cc65 <tag/Availability/cc65
<tag/See also/ <tag/See also/
@ -3590,6 +3591,8 @@ while (dev != INVALID_DEVICE) {
<tag/Description/The function returns the next device after <tt/device/. <tag/Description/The function returns the next device after <tt/device/.
The constant <tt/INVALID_DEVICE/ indicates no further device. The constant <tt/INVALID_DEVICE/ indicates no further device.
<tag/Notes/<itemize> <tag/Notes/<itemize>
<item>Calling getnextdevice() does <em/not/ turn on the motor of a
drive-type device and does <em/not/ check for a disk in the drive.
<item>The function is only available as fastcall function, so it may only <item>The function is only available as fastcall function, so it may only
be used in presence of a prototype. be used in presence of a prototype.
</itemize> </itemize>