About
Docs
Files
Support
Index

Essentials
AutoDocs
Library functions
Cooperate
Process mastering
Debug
Own debugging kit
FGE
Smart modeid pick
Loader
Shared lib. loader
Macros
Helper macros
Structs
All the structures
Logs
Library changelogs
Tools
Progs baked inside

Tools
amiscreen0.3
ansifilter0.1
auto2guide0.1
ccfilter0.1
chipset0.1
cputype0.1
device640.1
dupfilter0.1
expandlogs0.1
findsm0.2
fmpp0.1
fsmount0.1
genanim0.3
gensymtab0.1
hashlab0.4
ktm0.6
linkpoint0.1
logo2ilbm0.1
lpradio0.1
lzwpack0.1
minism0.2
mkheader0.1
modeidctrl0.1
mss0.6
multisum0.3
newterm0.2
numconv0.1
palhack1.1
patmat0.1
pfr0.2
playamitape0.1
qdbflags0.1
qfill0.1
resmodinit0.2
sadctrl0.2
saveassign0.1
setanim0.2
systime0.1
tokendump0.1
uassign0.1
viewlogo0.1
waitback0.4
wrapmount0.1



A
U
T
O
2
G
U
I
D
E

auto2guide-0.1
---------------

---

With  'auto2guide'  it is possible to create browsable AmigaGuide documents
out of 'qdev' AutoDocs. Resulting docs offer way better API experience than
classic mono-styled text scroll. If you did not yet generate  API reference
in a  #?.guide  format then it is the right time to do so. Get boinged will
ya?

---

NOTES:

[*]
Requires  68020(no FPU)+,  OS2.04(theoretically)+, 16+ kilo of free memory.

[*]
If  you are on low memory  setup(1 meg of memory only)  then after document
generation  check contents of last  reference(follow last link in the  TOC)
for error message.

[*]
Program  does the conversion based  on the text  layout mostly. No  special
markers. The only exception to that rule is the FF character that describes
top of chapter.

[*]
This program totally discards static TOC as placed at the top of input file
and makes new TOC based on what was found during processing.

---

HELP:

   > auto2guide ?

     AF=AUTOFILE/A



   AF=AUTOFILE/A    -  Input file, 'qdev' cleartext  documentation  format.

---

USAGE:

   ; Create handy reference manuals of API and macros
   cd libqdev-x.x-bin-m68k/docs
   /tools/auto2guide-0.1/auto2guide qdev_macros.txt >qdev_macros.guide
   /tools/auto2guide-0.1/auto2guide qdev_autodocs.txt >qdev_autodocs.guide

---
megacz
    














































No more fear cus pure HTML is here!
Copyright (C) 2013-2014 by Burnt Chip Dominators