NDK3.2r4 Autodoc/AG broken "SEE ALSO" links
This started a long time ago with me copy-pasting a function-name from the "SEE ALSO" part of one of the NDK autodocs and got a compile error because one letter had the wrong case, and realizing too late that I should have made a note of where the error was so I could report it.
This has been bothering me since, and some days ago I realized that if I grep-ed all the "SEE ALSO"-parts from the AmigaGuide into one file and loaded it in a editor with AmigaGuide syntax highlighting I could easily spot broken links and find it again.
I found a few more issues than the one I was looking for. The Result is below, but first a quick explanation:
This lists the Function-/Macro-names that has broken links, and ignores broken links to .h/.i files as I was halfway trough the list when I realized that some of them have working links. The relevant lines grepped from the AmiGaGuides are listed as:
filename-linenumber-linecontent
separated by a few "---" and my comment/best-guess for fix added after the last "---" before each new grep-output.
"Listed as" refers to the name used in the autodoc index/section-headers.
"Does not exist" refers to the contents of the autodocs and their indexes.
"- Line n" refers to the line-number in the corresponding .doc file.
Hope this is somewhat useful:
-- Listed as KPrintF - Line 889
amiga_lib:931:@{b} SEE ALSO@{ub}
amiga_lib-932- @{"commodities.library/CreateCxObj()" Link "commodities/CreateCxObj()"}, @{"CxSender()" Link "CxSender()"}, debug.lib/kprintf()
amiga_lib-933-
amiga_lib-934-@EndNode
amiga_lib-935-
--
--
-- Points to self, Should be ObtainInfoA()? - Line 281
bullet:293:@{b} SEE ALSO@{ub}
bullet-294- ReleaseInfoA(), @{"diskfont/diskfonttag.h" Link "INCLUDE:diskfont/diskfonttag.h/Main" 0}, @{"diskfont/oterrors.h" Link "INCLUDE:diskfont/oterrors.h/Main" 0}
bullet-295-
bullet-296-@EndNode
bullet-297-
--
--
-- Listed as DoGadgetMethodA() - Line 409
datatypes:429:@{b} SEE ALSO@{ub}
datatypes-430- intuition.library/DoGadgetMethod()
datatypes-431-
datatypes-432-@EndNode
datatypes-433-
--
--
-- Listed as ObtainDTDrawInfoA - Line 461
datatypes:483:@{b} SEE ALSO@{ub}
datatypes-484- ObtainDTDrawInfo(), @{"ReleaseDTDrawInfo()" Link "ReleaseDTDrawInfo()"}
datatypes-485-
datatypes-486-@EndNode
datatypes-487-
--
--
-- Listed as NewObject - Line 988
datatypes:1033:@{b} SEE ALSO@{ub}
datatypes-1034- @{"AddDTObject()" Link "AddDTObject()"}, @{"DisposeDTObject()" Link "DisposeDTObject()"}, @{"RemoveDTObject()" Link "RemoveDTObject()"},
datatypes-1035- intuition.library/NewObjectA()
datatypes-1036-
datatypes-1037-@{b} BUGS@{ub}
--
--
-- Listed as ObtainDTDrawInfoA - Line 1245
datatypes:1303:@{b} SEE ALSO@{ub}
datatypes-1304- @{"DrawDTObjectA()" Link "DrawDTObjectA()"}, ObtainDTDrawInfo()
datatypes-1305-
datatypes-1306-@EndNode
datatypes-1307-
--
--
-- Points to self - Line 65
disk:71:@{b} SEE ALSO@{ub}
disk-72- FreeUnit
disk-73-
disk-74-@{b} BUGS@{ub}
disk-75- Doesn't check if you own the unit, or even if anyone owns it.
--
--
-- Link missing, no apparent errors found - Line 661
dos:691:@{b} SEE ALSO@{ub}
dos-692-@{b} DoShellMethod()@{ub}
dos-693-
dos-694-@EndNode
dos-695-
--
--
-- Listed as SystemTagList - Line 746
dos:780:@{b} SEE ALSO@{ub}
dos-781- @{"ReplyPkt()" Link "ReplyPkt()"}, @{"WaitPkt()" Link "WaitPkt()"}, System(), @{"Execute()" Link "Execute()"}, @{"IoErr()" Link "IoErr()"}
dos-782-
dos-783-@EndNode
dos-784-
--
--
-- Should be StrToDate - Line 1201
dos:1251:@{b} SEE ALSO@{ub}
dos-1252- @{"DateStamp()" Link "DateStamp()"}, StrtoDate(), @{"<dos/datetime.h>" Link "INCLUDE:dos/datetime.h/Main" 0}
dos-1253-
dos-1254-@EndNode
dos-1255-
--
--
-- NewUnLoadSeg() does not exist - Line 3129
dos:3283:@{b} SEE ALSO@{ub}
dos-3284- @{"LoadSeg()" Link "LoadSeg()"}, @{"UnLoadSeg()" Link "UnLoadSeg()"}, @{"InternalLoadSeg()" Link "InternalLoadSeg()"}, NewUnLoadSeg(), @{"Close()" Link "Close()"}
dos-3285-
dos-3286-@EndNode
dos-3287-
--
--
-- SetProtect() does not exist, should be SetProtection()? - Line 5299
dos:5573:@{b} SEE ALSO@{ub}
dos-5574- SetProtect(), @{"Examine()" Link "Examine()"}, @{"ExNext()" Link "ExNext()"}, @{"ExAll()" Link "ExAll()"}, @{"<dos/dos.h>" Link "INCLUDE:dos/dos.h/Main" 0}
dos-5575-
dos-5576-@EndNode
dos-5577-
--
--
-- Points to self - Line 4141
exec:4331:@{b} SEE ALSO@{ub}
exec-4332- @{"AddHead" Link "exec/AddHead()"}, @{"AddTail" Link "exec/AddTail()"}, @{"Enqueue" Link "exec/Enqueue()"}, @{"Insert" Link "exec/Insert()"}, @{"Remove" Link "exec/Remove()"}, @{"RemHead" Link "exec/RemHead()"}, RemTail
exec-4333-
exec-4334-@EndNode
exec-4335-
--
--
-- Listed as GT_SetGadgetAttrsA and GetVisualInfoA - Line 455
gadtools:461:@{b} SEE ALSO@{ub}
gadtools-462- @{"FreeGadgets()" Link "FreeGadgets()"}, GT_SetGadgetAttrs(), GetVisualInfo(),
gadtools-463- @{"SetDesignFontA()" Link "SetDesignFontA()"}, @{"ScaleGadgetRectA()" Link "ScaleGadgetRectA()"}, @{"<libraries/gadtools.h>" Link "INCLUDE:libraries/gadtools.h/Main" 0}
gadtools-464-
gadtools-465-@EndNode
--
--
-- Listed as GT_SetGadgetAttrsA - Line 974
gadtools:1000:@{b} SEE ALSO@{ub}
gadtools-1001- GT_SetGadgetAttrs()
gadtools-1002-
gadtools-1003-@EndNode
gadtools-1004-
--
--
-- Listed as GT_GetGadgetAttrsA - Line 1304
gadtools:1340:@{b} SEE ALSO@{ub}
gadtools-1341- GT_GetGadgetAttrs()
gadtools-1342-
gadtools-1343-@EndNode
gadtools-1344-
--
--
-- Listed as GPD_SETCTYPE and GPD_SETTRIGGER - Line 115
gameport:123:@{b} SEE ALSO@{ub}
gameport-124- gameport.device/SetCType, gameport.device/SetTrigger
gameport-125-
gameport-126-@EndNode
gameport-127-
--
--
-- RASSIZE does not exist - Line 1940
graphics:1993:@{b} SEE ALSO@{ub}
graphics-1994- @{"AllocBitMap()" Link "AllocBitMap()"}, @{"AllocRaster()" Link "AllocRaster()"}, @{"BltBitMap()" Link "BltBitMap()"}, @{"BltBitMapRastPort()" Link "BltBitMapRastPort()"},
graphics-1995- @{"ClipBlit()" Link "ClipBlit()"}, @{"DrawImage()" Link "intuition/DrawImage()"}, @{"GetBitMapAttr()" Link "GetBitMapAttr()"}, RASSIZE(), @{"<graphics/gfx.h>" Link "INCLUDE:graphics/gfx.h/Main" 0}
graphics-1996- @{"<graphics/rastport.h>" Link "INCLUDE:graphics/rastport.h/Main" 0}
graphics-1997-
--
--
-- CINIT does not exist - Line 2089
graphics:2151:@{b} SEE ALSO@{ub}
graphics-2152- CINIT @{"CWAIT" Link "CWAIT"} @{"CMOVE" Link "CMOVE"} @{"CEND" Link "CEND"} @{"graphics/copper.h" Link "INCLUDE:graphics/copper.h/Main" 0}
graphics-2153-@EndNode
graphics-2154-
graphics-2155-@Node "CEND" "graphics.library/CEND"
--
--
-- CINIT does not exist - Line 2113
graphics:2177:@{b} SEE ALSO@{ub}
graphics-2178- CINIT @{"CWAIT" Link "CWAIT"} @{"CMOVE" Link "CMOVE"} @{"graphics/copper.h" Link "INCLUDE:graphics/copper.h/Main" 0}
graphics-2179-@EndNode
graphics-2180-
graphics-2181-@Node "ChangeExtSpriteA()" "graphics.library/ChangeExtSpriteA"
--
--
-- Link missing, no apprent reason - Line 2188
graphics:2256:@{b} SEE ALSO@{ub}
graphics-2257- @{"FreeSprite()" Link "FreeSprite()"} ChangeSprite() @{"MoveSprite()" Link "MoveSprite()"} @{"AddVSprite()" Link "AddVSprite()"} @{"graphics/sprite.h" Link "INCLUDE:graphics/sprite.h/Main" 0}
graphics-2258-
graphics-2259-@EndNode
graphics-2260-
--
--
-- CINIT does not exist - Line 2467
graphics:2553:@{b} SEE ALSO@{ub}
graphics-2554- @{"CMove()" Link "CMove()"}, @{"CBump()" Link "CBump()"}, CINIT @{"CWAIT" Link "CWAIT"} @{"CEND" Link "CEND"} @{"<graphics/copper.h>" Link "INCLUDE:graphics/copper.h/Main" 0}
graphics-2555-
graphics-2556-@EndNode
graphics-2557-
--
--
-- CINIT does not exist - Line 2565
graphics:2657:@{b} SEE ALSO@{ub}
graphics-2658- @{"CMove()" Link "CMove()"}, @{"CBump()" Link "CBump()"}, CINIT @{"CMOVE" Link "CMOVE"} @{"CEND" Link "CEND"} @{"<graphics/copper.h>" Link "INCLUDE:graphics/copper.h/Main" 0}
graphics-2659-
graphics-2660-@EndNode
graphics-2661-
--
--
-- Points to self and listed as GetExtSpriteA - Line 3166
graphics:3296:@{b} SEE ALSO@{ub}
graphics-3297- FreeSpriteData() @{"FreeSprite()" Link "FreeSprite()"} @{"ChangeSprite()" Link "ChangeSprite()"} @{"MoveSprite()" Link "MoveSprite()"} GetExtSprite()
graphics-3298- @{"AllocBitMap()" Link "AllocBitMap()"} @{"graphics/sprite.h" Link "INCLUDE:graphics/sprite.h/Main" 0}
graphics-3299-
graphics-3300-@EndNode
--
--
-- Should be GetOutlinePen - Line 3588
graphics:3742:@{b} SEE ALSO@{ub}
graphics-3743- @{"GetAPen()" Link "GetAPen()"} @{"GetBPen()" Link "GetBPen()"} @{"GetDrMd()" Link "GetDrMd()"} GetOutLinePen()
graphics-3744- GetWriteMask() @{"SetRPAttrA()" Link "SetRPAttrA()"} @{"graphics/rpattr.h" Link "INCLUDE:graphics/rpattr.h/Main" 0}
graphics-3745-
graphics-3746-@EndNode
--
-- Points to self - Line 3628
graphics:3784:@{b} SEE ALSO@{ub}
graphics-3785- @{"FreeSprite()" Link "FreeSprite()"} @{"ChangeSprite()" Link "ChangeSprite()"} @{"MoveSprite()" Link "MoveSprite()"} GetSprite() @{"graphics/sprite.h" Link "INCLUDE:graphics/sprite.h/Main" 0}
graphics-3786-
graphics-3787-@EndNode
graphics-3788-
--
--
-- Wrongly listed as GfxLookUP - Line 3693
graphics:3853:@{b} SEE ALSO@{ub}
graphics-3854- @{"graphics/gfxnodes.h" Link "INCLUDE:graphics/gfxnodes.h/Main" 0} @{"GfxNew()" Link "GfxNew()"} @{"GfxFree()" Link "GfxFree()"} GfxLookUp()
graphics-3855-
graphics-3856-@EndNode
graphics-3857-
--
--
-- Wrongly listed as GfxLookUP - Line 3724
graphics:3886:@{b} SEE ALSO@{ub}
graphics-3887- @{"graphics/gfxnodes.h" Link "INCLUDE:graphics/gfxnodes.h/Main" 0} @{"GfxNew()" Link "GfxNew()"} @{"GfxAssociate()" Link "GfxAssociate()"} GfxLookUp()
graphics-3888-
graphics-3889-@EndNode
graphics-3890-
--
--
-- Wrongly listed as GfxLookUP - Line 3783
graphics:3949:@{b} SEE ALSO@{ub}
graphics-3950- @{"graphics/gfxnodes.h" Link "INCLUDE:graphics/gfxnodes.h/Main" 0} @{"GfxFree()" Link "GfxFree()"} @{"GfxAssociate()" Link "GfxAssociate()"} GfxLookUp()
graphics-3951-
graphics-3952-@EndNode
graphics-3953-
--
--
-- SetOutLinePen does not exist - Line 6216
graphics:6500:@{b} SEE ALSO@{ub}
graphics-6501- @{"SetFont()" Link "SetFont()"} @{"SetSoftStyle()" Link "SetSoftStyle()"} @{"SetAPen()" Link "SetAPen()"} @{"SetBPen()" Link "SetBPen()"} @{"SetDrMd()" Link "SetDrMd()"} SetOutLinePen()
graphics-6502- @{"SetWriteMask()" Link "SetWriteMask()"} @{"SetMaxPen()" Link "SetMaxPen()"} @{"GetRPAttrA()" Link "GetRPAttrA()"} @{"graphics/rpattr.h" Link "INCLUDE:graphics/rpattr.h/Main" 0}
graphics-6503-
graphics-6504-@EndNode
--
--
-- CINIT does not exist - Line 7627
graphics:7961:@{b} SEE ALSO@{ub}
graphics-7962- @{"CBump()" Link "CBump()"} @{"CWAIT" Link "CWAIT"} CINIT @{"CMOVE" Link "CMOVE"} @{"CEND" Link "CEND"} @{"<graphics/copper.h>" Link "INCLUDE:graphics/copper.h/Main" 0}
graphics-7963-
graphics-7964-@EndNode
graphics-7965-
--
--
-- Listed as DrawIconStateA - Line 865
icon:897:@{b} SEE ALSO@{ub}
icon-898- @{"workbench/icon.h" Link "INCLUDE:workbench/icon.h/Main" 0}
icon-899- @{"workbench/workbench.h" Link "INCLUDE:workbench/workbench.h/Main" 0}
icon-900- icon.library/DrawIconState
icon-901- @{"icon.library/IconControlA" Link "icon/IconControlA()"}
--
--
-- Listed as LayoutIconA - Line 1611
icon:1646:@{b} SEE ALSO@{ub}
icon-1647- @{"dos.library/IoErr" Link "dos/IoErr()"}
icon-1648- @{"icon.library/DupDiskObjectA" Link "icon/DupDiskObjectA()"}
icon-1649- @{"icon.library/GetIconTagList" Link "icon/GetIconTagList()"}
icon-1650- icon.library/LayoutIcon
--
--
-- Listed as SetAttrsA - Line 1624
intuition:1672:@{b} SEE ALSO@{ub}
intuition-1673- @{"NewObject()" Link "NewObject()"}, SetAttrs(), @{"GetAttr()" Link "GetAttr()"}, @{"MakeClass()" Link "MakeClass()"},
intuition-1674- Document "Basic Object-Oriented Programming System for Intuition"
intuition-1675- and the "boopsi Class Reference" document.
intuition-1676-@EndNode
--
--
-- Listed as SetAttrsA - Line 2484
intuition:2564:@{b} SEE ALSO@{ub}
intuition-2565- @{"NewObject()" Link "NewObject()"}, @{"DisposeObject()" Link "DisposeObject()"}, SetAttrs(), @{"MakeClass()" Link "MakeClass()"},
intuition-2566- Document "Basic Object-Oriented Programming System for Intuition"
intuition-2567- and the "boopsi Class Reference" document.
intuition-2568-
--
--
-- GetLBColumnInfoAttrsA(), SetLBColumnInfoAttrsA() does not exist - Line 744
listbrowser_gc:750:@{b} SEE ALSO@{ub}
listbrowser_gc-751- @{"FreeLBColumnInfo()" Link "FreeLBColumnInfo()"}, GetLBColumnInfoAttrsA(), SetLBColumnInfoAttrsA()
listbrowser_gc-752-
listbrowser_gc-753-@EndNode
listbrowser_gc-754-
--
--
-- SetLBColumnInfoAttrsA() does not exist - Line 890
listbrowser_gc:906:@{b} SEE ALSO@{ub}
listbrowser_gc-907- @{"AllocLBColumnInfoA()" Link "AllocLBColumnInfoA()"}, SetLBColumnInfoAttrsA()
listbrowser_gc-908-
listbrowser_gc-909-@EndNode
listbrowser_gc-910-
--
--
-- reaction.lib/LBAddNode does not exist - Line 991
listbrowser_gc:1015:@{b} SEE ALSO@{ub}
listbrowser_gc-1016- @{"LBM_EDITNODE" Link "LBM_EDITNODE"}, @{"LBM_REMNODE" Link "LBM_REMNODE"}, reaction.lib/LBAddNode
listbrowser_gc-1017-
listbrowser_gc-1018-@EndNode
listbrowser_gc-1019-
--
--
-- reaction.lib/LBEditNode does not exist - Line 1018
listbrowser_gc:1044:@{b} SEE ALSO@{ub}
listbrowser_gc-1045- @{"LBM_ADDNODE" Link "LBM_ADDNODE"}, @{"LBM_REMNODE" Link "LBM_REMNODE"}, reaction.lib/LBEditNode
listbrowser_gc-1046-
listbrowser_gc-1047-@EndNode
listbrowser_gc-1048-
--
--
-- Points to self, and reaction.lib/LBRemNode does not exist - Line 1044
listbrowser_gc:1072:@{b} SEE ALSO@{ub}
listbrowser_gc-1073- @{"LBM_ADDNODE" Link "LBM_ADDNODE"}, LBM_REMNODE, reaction.lib/LBRemNode
listbrowser_gc-1074-
listbrowser_gc-1075-@EndNode
listbrowser_gc-1076-
--
--
-- GetLBColumnInfoAttrsA() does not exist - Line 1270
listbrowser_gc:1306:@{b} SEE ALSO@{ub}
listbrowser_gc-1307- @{"AllocLBColumnInfoA()" Link "AllocLBColumnInfoA()"}, GetLBColumnInfoAttrsA()
listbrowser_gc-1308-
listbrowser_gc-1309-@EndNode
listbrowser_gc-1310-
--
--
-- Should be IEEEDPAcos() - Line 91
mathieeedoubtrans:99:@{b} SEE ALSO@{ub}
mathieeedoubtrans-100- @{"IEEEDPTan()" Link "IEEEDPTan()"}, @{"IEEEDPAsin()" Link "IEEEDPAsin()"}, IEEEDPACos()
mathieeedoubtrans-101-@EndNode
mathieeedoubtrans-102-
mathieeedoubtrans-103-@Node "IEEEDPCos()" "mathieeedoubtrans.library/IEEEDPCos"
--
--
-- Link missing, No apparent error - Line 271
mathtrans:291:@{b} SEE ALSO@{ub}
mathtrans-292- @{"SPExp" Link "mathtrans/SPExp()"}, SpLog
mathtrans-293-
mathtrans-294-@EndNode
mathtrans-295-
--
--
-- Points to self, also PRD_DUMPRPORT@ is listed twice was it ment to point to the other PRD_DUMPRPORT? - Line 361
printer:385:@{b} SEE ALSO@{ub}
printer-386-@{b} printer.device/PRD_DUMPRPORT@{ub}
printer-387-
printer-388-@EndNode
printer-389-
--
--
-- Listed as GetPlayerAttrsA - Line 106
realtime:110:@{b} SEE ALSO@{ub}
realtime-111- @{"DeletePlayer()" Link "DeletePlayer()"}, GetPlayerAttrs(), @{"SetPlayerAttrs()" Link "SetPlayerAttrs()"}
realtime-112-
realtime-113-@EndNode
realtime-114-
--
--
-- Listed as GetPlayerAttrsA - Line 442
realtime:462:@{b} SEE ALSO@{ub}
realtime-463- @{"CreatePlayer()" Link "CreatePlayer()"}, @{"DeletePlayer()" Link "DeletePlayer()"}, GetPlayerAttrs()
realtime-464-
realtime-465-@EndNode
realtime-466-
--
--
-- Points to self - Line 691
scsidisk:733:@{b} SEE ALSO@{ub}
scsidisk-734- TD_WRITE64, @{"TD_READ64" Link "TD_READ64"}, @{"TD_FORMAT64" Link "TD_FORMAT64"}
scsidisk-735-
scsidisk-736-@EndNode
scsidisk-737-
--
--
-- Points to self, should be ToLower()? - Line 1382
utility:1458:@{b} SEE ALSO@{ub}
utility-1459- ToUpper(), @{"locale.library/ConvToLower()" Link "locale/ConvToLower()"}
utility-1460-
utility-1461-@EndNode
utility-1462-
--
--
-- Link missing, no apparent error - Line 111
virtual_gc:115:@{b} SEE ALSO@{ub}
virtual_gc-116- layout.gadget/--datasheet--
virtual_gc-117-
virtual_gc-118-@EndNode
virtual_gc-119-
Online Status
thanks a lot