Mistakes in the documentation

Have a question about our Software Developer Kit? Ask them here.

Mistakes in the documentation

Postby Alpyre » Wed Dec 05, 2018 7:38 am

I've encountered some mistakes as I go through the documentation and noted them down. Here they are for your attention:
Code: Select all
application.doc:
  - Identifiers READPREFS_LastAppDocs,
                WRITEPREFS_LastAppDocs,
                REGAPP_Name
  ...are explained but they are not defined in the headers.

  - a typedef c_time is mentioned but not defined in the headers.

  - AppLibMsg and AppLibOpenPrintDocMsg structs are mentioned but not defined
    in the headers.

intuition.doc:
  WA_Flags is not mentioned in SetWindowAttr

bsdsocket.doc:
  - Error identifier EACCES is misspelled as EACCESS (many times)
  - SIOCSIFADDR is misspelled as SIOCIFADDR
  - BIOCSETIF is misspelled as BIOSETIF
  - IFNAMSIZ is misspelled as IFNAMSIZE
Alpyre
 
Posts: 1
Joined: Wed Jul 04, 2018 9:26 am

Re: Mistakes in the documentation

Postby broadblues » Wed Dec 05, 2018 3:26 pm

Alpyre wrote:I've encountered some mistakes as I go through the documentation and noted them down. Here they are for your attention:
application.doc:
- Identifiers READPREFS_LastAppDocs,
WRITEPREFS_LastAppDocs,
REGAPP_Name
...are explained but they are not defined in the headers.

- a typedef c_time is mentioned but not defined in the headers.

- AppLibMsg and AppLibOpenPrintDocMsg structs are mentioned but not defined
in the headers.


With the exception of #?PRESF_LastApppDoc these seam already addressed in the docs, it may be that the lastAppDocs is not implmented yet (not sure what it means TBH).
intuition.doc:
WA_Flags is not mentioned in SetWindowAttr


It's not an error, WA_Flags is not support by SetWindowAttrs(), only by GetWindowAttrs().
bsdsocket.doc:
- Error identifier EACCES is misspelled as EACCESS (many times)
- SIOCSIFADDR is misspelled as SIOCIFADDR
- BIOCSETIF is misspelled as BIOSETIF
- IFNAMSIZ is misspelled as IFNAMSIZE


I'll leave those for someone else (with more knowledge) to comment on
User avatar
broadblues
AmigaOS Core Developer
AmigaOS Core Developer
 
Posts: 551
Joined: Sat Jun 18, 2011 3:40 am
Location: Portsmouth, UK


Return to SDK Support

Who is online

Users browsing this forum: Majestic-12 [Bot] and 2 guests