ain@j.cc.purdue.edu (Patrick White) (06/10/88)
Submitted by: slmyq@usu.bitnet
Summary: Extract documents from files.
Poster Boy: Patrick White (ain@j.cc.purdue.edu)
Archive Name: binaries/amiga/volume6/docextract.sh.Z
Tested.
NOTES:
-- Pat White (co-moderator comp.sources/binaries.amiga)
ARPA/UUCP: j.cc.purdue.edu!ain BITNET: PATWHITE@PURCCVM PHONE: (317) 743-8421
U.S. Mail: 320 Brown St. apt. 406, West Lafayette, IN 47906
[How do you get to heaven? Go to Pluto and hang a left.]
========================================
# This is a shell archive.
# Remove everything above and including the cut line.
# Then run the rest of the file through sh.
#----cut here-----cut here-----cut here-----cut here----#
#!/bin/sh
# shar: Shell Archiver
# Run the following text with /bin/sh to create:
# SDX.doc
# SDX.uu
# This archive created: Fri Mar 11 23:58:11 1988
echo shar: extracting SDX.doc
sed 's/^XX//' << \SHAR_EOF > SDX.doc
XX
XX SDX
XX Simple Documentation Extractor
XX Copyright (C) 1988 by Bryan Ford
XX
XX SDX is a program which scans through C source code for documentation,
XXand extracts it into a file. I wrote it because Fred Fish's dex was much
XXmore than I needed, and somewhat harder to use, mainly because you had to
XXhave a .dexrc file. Also, it required its output to be run through a
XXtext processor, and for some reason my text processor didn't like the
XXoutput files it created, in that backslashes were inserted before
XXevery period. This is why I call it the "simple" documentation extractor -
XXbecause it doesn't have any fancy styles or boxes around titles - it just
XXextracts documentation.
XX To run SDX, just type SDX file1 file2 file3... Wildcards are allowed,
XXbut right now my wildcard routines are quite buggy (I just wanted to get
XXthis program *out*), so the only wildcards you can use are the single
XXasterisk (*), or a single #?, both of which mean "all the files in this
XXdirectory". This shouldn't be too much of a problem, because I *doubt* it
XXwill find documentation in non-source code. The output goes to the
XXstandard output, so you'll probably want to redirect it.
XX In all source files, SDX searches for strings like this:
XX<nl>/*<nl><sp>*<sp><sp>, where <nl> is a newline and <sp> is a space.
XXThen it checks the line that started with <sp>*<sp><sp>. If all of the
XXcharacters on that line are either non-alphabetic or uppercase, it starts
XXextracting. If there are any lowercase characters, it skips it and tries
XXto find the search string again.
XX If it finds documentation, it will extract it to stdout, with the
XX<sp>*<sp><sp> changed to four spaces. Tabs just after the first asterisk
XXare changed to six spaces, but others aren't affected. It stops extracting
XXwhen it comes to a line without <sp>* at the beginning, finds a <sp>*/
XXline, or finds the end of the file. It will then output a form-feed
XXcharacter to the standard output (which will clear the screen on the
XXAmiga's console device).
XX Now that the technical junk is over, this sample doc should clarify
XXthings. It is for a function named `xyz' which prints the specified string
XXto the screen, and returns TRUE if it was successful.
XX
XX/*
XX * FUNCTION
XX * xyz - Prints a string to the screen
XX *
XX * SYNOPSIS
XX * Success = xyz(String)
XX *
XX * DESCRIPTION
XX * Prints the string to the screen
XX *
XX * INPUTS
XX * String - Pointer to the string to print
XX *
XX * RETURNS
XX * Returns TRUE if it was successful, or FALSE if unsuccessful.
XX *
XX */
XX
XX Although this might not be a very good example, it shows how things
XXwork. I have used this program to extract documentation on my huge (30K)
XXcustom library, and it has worked nicely.
XX Now for what you've all been waiting for. This program is in a way
XXShareware, but I won't require you to send a donation. If you like this
XXprogram, and think it's worth something, just send whatever you think it's
XXworth to my address below. This program is freely distributable, so you
XXcan copy it as much as you like, and are encouraged to do so.
XX I'm also interested in what anyone has to say about this program, or
XXideas for other useful utilities which need making. My address is below.
XX
XX Snail: Bryan Ford
XX 1790 East 1400 North
XX Logan, UT 84321
XX Fone: (801)753-1159
XX Bitnet: FATQW@USU
XX
SHAR_EOF
if test 3331 -ne "`wc -c SDX.doc`"
then
echo shar: error transmitting SDX.doc '(should have been 3331 characters)'
fi
echo shar: extracting SDX.uu
sed 's/^XX//' << \SHAR_EOF > SDX.uu
XX
XXbegin 644 SDX
XXM```#\P`````````$``````````,````"````!@``!(\```#2```#Z0````).F
XXM^0```````````^P````!`````@````(````````#\@```^L````&```#\@``+
XXM`^D```2/(\\````<(\`````D(\@````H+'D````$(\X````$D\E.KO[:*$!*G
XXMK`"L9P``]F$``8R1R"`L`*SEB"`P"!#EB$CG`#!%^0```*Q'^0```"P@0'``[
XXM$!A",`@`)L@@.0```"0@>0```"A#\`@`#"$`(%+(__I"*0`!$AAG7`P!`"!G6
XXM]@P!``EG\";*#`$`(F<4%,$2&&="#`$`(&<$%,%@\D(:8-02&&<P#`$`(F?R]
XXM#`$`*F8@$A@,`0!.9P8,`0!N9@1R"F`.#`$`16<&#`$`968"<AL4P6#,0A)"[
XXMDR`\````*)"+1H#DB$S?#`!(>0```"PO`$ZY```'I"/`````$$ZY```'M"/`!
XXM````%"/`````&$ZY```$1G``+GD````<3G5A``"880``@B/`````("\`0J<DQ
XXM0"`J`"1G$"QY````""!`(B@``$ZN_X).N0``!$9P`&`$("\`!"YY````'"\`C
XXM+'D````$(#D````(9P8B0$ZN_F)*N0```"!G#DZN_WPB>0```"!.KOZ&(!].,
XXM=4CG`08N/``#@`<L>``$3J[_E$S?8(!P9&"P0>P`7$ZN_H!![`!<3J[^C$YU:
XXM0_H`$G``3J[]V"/`````"&?"3G5D;W,N;&EB<F%R>0!.5O^D2.<@`"\\```#4
XXM[2\N``A.N0``#,Q0CRU`_ZI*@&8(3-\`!$Y>3G5P`2\`2&[_KR\N_ZI.N0``-
XXM#6Y/[P`,4X!G%"\N_ZI.N0``$8Y8CTS?``1.7DYU$"[_KPP```IFR$*N_Z8@I
XXM;O^FT?P```&L(B[_IA`V&*\4$+`"9CA2KO^F0>[_K]'N_Z9P`2\`+P@O+O^J&
XXM3KD```UN3^\`#%.`9\0O+O^J3KD``!&.6(],WP`$3EY.=2`N_Z8,@`````=OP
XXMEAUV"*__LW`$+4#_IE*N_Z9![O^OT>[_IG`!+P`O""\N_ZI.N0``#6Y/[P`,G
XXM4X!G%"\N_ZI.N0``$8Y8CTS?``1.7DYU<``B+O^F$#88KU*`($#1_````C00V
XXM$`(```-*`&<8<``0-ABO4H`@0-'\```"-!`0"````&<8(B[_IA`V&*\,```*/
XXM9PH,@0```%!M`/]\(B[_IA`V&*\,```*9@#^]D)N_Z0@+O^F0C8(KTAN_[-(-
XXM>0```;5.N0``!OQ0CW#_+4#_IE*N_Z9![O^OT>[_IG`!+P`O""\N_ZI.N0``B
XXM#6Y/[P`,4X!G%"\N_ZI.N0``$8Y8CTS?``1.7DYU("[_I@R``````F8F$#8(?
XXMKPP```EF''`@+P!P!B\`2&[_L4ZY```*`$_O``QP!RU`_Z8B+O^F$#88KPP`"
XXM``IG"`R!````4&V`("[_ID(V"*](>0```;Y(;O^O3KD```D,4(]*@&<4$"[_&
XXMKPP``"!F"A`N_[`,```J9P@]?``!_Z1@#@RN````!/^F;@1"+O^S2F[_I&<`A
XXM_PY(>0```<).N0``!OQ8CV``_?!.5O]J#*X````"``AE&DAY```!Q2!N``PON
XXM*``$3KD```D,4(]*@&8V2'D```''3KD```;\6(](>0```>A.N0``!OQ8CTAYA
XXM```"!TZY```&_%B/<`4O`$ZY```!5EB/<`HO`$ZY```''%B//7P``?_^,"[_P
XXM_DC`L*X`"&0``>8P+O_^2,#E@"!N``S1P"\03KD``!',6(]*@&<``:IP_RU`L
XXM_VYP`2\`+SP```$$3KD```A<4(\M0/_Z2H!G``&>,"[__DC`Y8`@;@`,T<!P@
XXM9"\`+Q!(;O^53KD```EV3^\`#'`O+P!(;O^53KD```CB4(\M0/]J2H!F%'`Z8
XXM+P!(;O^53KD```CB4(\M0/]J2J[_:F8<<!XO`$AN_Y5(;O]V3KD```EV3^\`X
XXM#$(N_Y5@,"!N_VI2B'`>+P`O"$AN_W9.N0``"79/[P`,(&[_:A`0#```.F8$G
XXM4J[_:B!N_VI"$!`N_Y5*`&=`</XO`$AN_Y5.N0``!^!0CRU`_W)*@&86+SP`X
XXM``$$+R[_^DZY```(=%"/8```R"\N_W).N0``"$A8CRU`_VY@$D*G3KD```B,!
XXM6(\@0"UH`)C_<B\N__HO+O]R3KD```@04(]*@&="+R[_^B\N_W).N0``""Q0I
XXMCTJ`9RX@;O_Z4(A(;O]V+PA.N0``"AA0CU.`9M0@;O_Z2J@`!&K*4(@O"&$`E
XXM^XY8CV"^("[_;@R`_____V<6+P!.N0``"$A8CR\N_W).N0``!_Q8CR\\```!F
XXM!"\N__I.N0``"'10CV`6,"[__DC`Y8`@;@`,T<`O$&$`^T!8CU)N__Y@`/X02
XXM3EY.=4CG`#HH;P`4(&\`&")O`!Q%^@`Z3^__="9/+'D````$3J[]]G#_2AM7Y
XXMR/_\1H!G$B\`2&\`!$A43KD```>(3^\`#$_O`(Q,WUP`3G46P$YU+P(D+P`(A
XXM2&\`#"\"+SD````43KD```:L3^\`#"0?3G4O`A0O``M(@DC"+P)(>0```C!.^
XXMN0``!OQ0CR0?3G4``$CG(`(L>0````A,[P`&``Q.KO_B3-]`!$YU```O#BQY<
XXM````""(O``A.KO_<+%].=4CG,`(L>0````A,[P`.`!!.KO_63-]`#$YU``!(`
XXMYS`"+'D````(3.\`#@`03J[_T$S?0`Q.=0``+PXL>0````A.KO_*+%].=2\.>
XXM+'D````(3J[_Q"Q?3G5(YS`"+'D````(3.\`#@`03J[_ODS?0`Q.=0``2.<@C
XXM`BQY````"$SO``8`#$ZN_ZQ,WT`$3G4``"\.+'D````((B\`"$ZN_Z8L7TYU'
XXM2.<@`BQY````"$SO``8`#$ZN_YI,WT`$3G4``$CG(`(L>0````A,[P`&``Q.K
XXMKO^43-]`!$YU```O#BQY````""(O``A.KO^"+%].=2\.+'D````$3.\``P`(M
XXM3J[_.BQ?3G4``"\.+'D````$(F\`""`O``Q.KO\N+%].=2\.+'D````$(F\`+
XXM"$ZN_MHL7TYU3E8``"!N``@0$+`N``]F!B`(3EY.=2!N``@0$%*N``A*`&;@"
XXM<`!.7DYU3E8``'``$"X`#R\`+RX`"&'$4(].7DYU3E;__$*N__P@;@`(2A!GH
XXM$A`0L"X`#V8$+4C__%*N``A@YB`N__Q.7DYU3E8``"!N``@0$"!N``P2$+`!&
XXM9A1*`&8&<`!.7DYU4JX`"%*N``Q@W'``(&X`"!`0<@`@;@`,$A"0@4Y>3G4`S
XXM`$Y6__PM;@`(__P@;O_\4J[__")N``P0$1"`4JX`#$H`9N@@+@`(3EY.=4Y6;
XXM__PM;@`(__Q*K@`0;R`@;@`,$!`B;O_\$H!2K@`,2@!G#%*N__Q.<5.N`!!@[
XXMVB!N__Q"$"`N``A.7DYU3E;__$*N__P@;@`(T>[__!`02@!G!E*N__Q@["`N`
XXM__Q.7DYU(&\`!")O``@@+P`,;Q:SR&4,T<#3P!,@4X!F^DYU$MA3@&;Z3G4`/
XXM`"!O``0@+P`(;PHB+P`,$,%3@&;Z3G4``$Y6__I(YP$`2'D```,X+RX`#$ZY`
XXM```)#%"/2H!G*DAY```#.B\N``Q.N0``"0Q0CTJ`9Q0O+@`,+RX`"$ZY```)4
XXM#%"/2H!F"G`!3-\`@$Y>3G5^`"\N``Q.N0``";18CR('2,&R@&P``1P@!TC`>
XXM(&X`"-'`$!!*`&8*<`!,WP"`3EY.=2`'2,`@;@`,T<`0$`P``"=F"%*N``Q@2
XXM``#`(`=(P"!N``S1P!(0#`$`*F<:#`$`(V8``)12@"!N``S1P!`0#```/V8`L
XXM`((@;@`,4H@@!TC`+4@`#-'`$!`,```C9@12K@`,(`=(P"!N``S1P!`02@!FF
XXM"G`!3-\`@$Y>3G4O+@`(3KD```FT6(\B!TC!LH!L+"`'2,`@;@`(T<`B;@`,3
XXMT\`O"2\(80#^UE"/4T!F"G`!3-\`@$Y>3G521V#`<`!,WP"`3EY.=2`'2,`@V
XXM;@`,T<`0$`P``#]G(B`'2,`@;@`,T<`B;@`(T\`0$!(1L`%G"G``3-\`@$Y>P
XXM3G521V``_M(O+@`(3KD```FT6(\O+@`,+T``"$ZY```)M%B/(B\`!+*`9PIP/
XXM`$S?`(!.7DYU<`%,WP"`3EY.=4Y6``!"ITZY```(C%B/($`A;@`(`)1.7DYUN
XXM(#D````((CD````,LH!G'G+_+P$O`"\Y`````$ZY```'Q$_O``Q2@&8$<`!.-
XXM=2/Y````"`````QP`4YU3E;__$JY````%&<(2GD````09@Q"IV&26(]P`$Y>B
XXM3G5AHDJ`9@9P_TY>3G4P.0```!!(P"\`+SD````$+SD````43KD```>(3^\`&
XXM##`Y````$$C`+P`O.0````0O.0````!.N0``!XA/[P`,+4#__%*`9@9P_TY>Q
XXM3G4@+O_\T;D````,,CD````02,&P@6P$3EY.=4*Y````%"`N__Q.7DYU3E8`A
XXM`$JY`````&<4+RX`#"\N``A.N0``!SQ0CTY>3G5P`2\`+SP```(`3KD```A<<
XXM4(\CP`````1*@&8&<`!.7DYU+RX`#"\N``A.N0``!SQ0CR/``````$J`9AHON
XXM/````@`O.0````1.N0``"'10CW``3EY.=7``,\`````0(\`````((\`````4`
XXM2,`SP````!(CP`````P@.0````!.7DYU3E;_^$*N__@@+@`((CD`````LH!G0
XXM&"\N`!`O+@`,+P!.N0``!VQ/[P`,3EY.=4JN`!!O``#P,#D````22,`R.0``E
XXM`!!(P;"!;&J2@+*N`!!O!B`N`!!@$C`Y````$$C`,CD````22,&0@3(Y````J
XXM$DC!('D````$T<$O`"\N``PO""U`__Q.N0``"=A/[P`,("[__)&N`!`R.0``V
XXM`!)(P=*`T:X`#-&N__@SP0```!)@`/]\80#^!E*`9@9P_TY>3G4P.0```!!(1
XXMP-&Y````"&$`_:Y*@&8&</].7DYU+SP```(`+SD````$+RX`"$ZY```';$_OH
XXM``PM0/_\4H!F!G#_3EY.=2`N__Q">0```!(SP````!!*@&8`_Q0@+O_X3EY.K
XXM=4*G80#]/EB/("[_^$Y>3G5.5O_X2.<@`$*N__@@+@`((CD`````LH!G'"\NI
XXM`!`O+@`,+P!.N0``!XA/[P`,3-\`!$Y>3G4,K@```@``$&\``(IA`/U$#+D`2
XXM```!````%&8*</],WP`$3EY.=3`Y````$DC`T;D````(<``SP````!(SP```/
XXM`!!A`/S22H!F"G#_3-\`!$Y>3G4O+@`0+RX`#"\N``A.N0``!XA/[P`,+4#_-
XXM_%*`9@IP_TS?``1.7DYU("[__-&Y````"-&Y````#$S?``1.7DYU0J=A`/QD$
XXM6(]*K@`0;P``^#`Y````$DC`(CP```(`DH"RK@`0;P8@+@`08!(P.0```!)(#
XXMP"(\```"`)*`(`$R.0```!)(P2!Y````!-'!+P`O""\N``PM0/_\3KD```G8G
XXM3^\`##`Y````$DC`T*[__#/`````$C(Y````$+)`;08P.0```!`B+O_\)"X`!
XXM$)2!TZX`#-.N__AR`2/!````%#/`````$"U"`!`,>0(`````$F8`_U1*@F\`D
XXM_TYA`/P`4H!F"G#_3-\`!$Y>3G4,N0````$````49@P@+O_X3-\`!$Y>3G4P8
XXM.0```!)(P-&Y````"'``,\`````2,\`````08`#_!"`N__A,WP`$3EY.=4Y6'
XXM__@@+@`((CD`````LH!G&"\N`!`O+@`,+P!.N0``!\1/[P`,3EY.=4JN`!!F7
XXM+C`Y````$DC`(BX`#-*`2H%K'#`Y````$DC`(BX`#-*`,#D````02,"R@&\`$
XXM`(XP.0```!)(P"(Y````"-*`+4'_^&$`^S@,N0````$````49@9P_TY>3G4O2
XXM+@`0+RX`#"\N``A.N0``!\1/[P`,4H!F!G#_3EY.=7``+P`O`"\N``A.N0``^
XXM!\1/[P`,+4#__%*`9@9P_TY>3G4@+O_\<@`CP`````PCP`````@SP0```!(SG
XXMP0```!!@'C`Y````$DC`(CD````(TH#0K@`,,\`````2+4'_^"`N__A.7DYUO
XXM3E8``"`N``BPN0````!F'F$`^HHO/````@`O.0````1.N0``"'10CT*Y````"
XXM`"\N``A.N0``!UA8CTY>3G5.5O_^2.<!`'X`+RX`"$ZY```)M%B/(@=(P;*`D
XXM;$@@!TC`2H!G$%.`(&X`"-'`$!`,```G9RP@!TC`(&X`"-'`<``0$"\`2'D`:
XXM``-`3KD```C*4(]*@&<*<`%,WP"`3EY.=5)'8*1P`$S?`(!.7DYU```#[```7
XXM`%`````!```1N```$:H``!&8```1?@``$7(``!%J```18@``$5P``!%6```1C
XXM4```$/H``!#F```0W@``$-```!#"```0L```$(@``!!J```09```$%P``!!4&
XXM```00```$!H``!`.```0"```#^X```_D```/W@``#](```^T```/K```#YH`5
XXM``]^```/8```#UH```\6```/$```#P@```\````.[@``#K0```Z````.>@``C
XXM#E0```XZ```.,@``#AH```X(```-X@``#=H```W0```-R```#:X```VF```-K
XXM?```#68```U@```-6@``#5(```U,```-1@``#3````T@```-````#-(```S`O
XXM```,L```#*H```R(```,@@``#'@```QB```,6```##@```PP```,(@``#!X`"
XXM``P&```+]@``"_````!'`````@``$AH``!'<```1P@``#\@```WV```.7@``)
XXM#9```!&P```--@``#/@```T8```,X@``#SH```[(```,C@``#&X``!$R```1_
XXM%```$)P```P,```+W```"[(```NB```+'@``"G(```I6```*0@``"BP```<PG
XXM```'$```!N8```9P```&-```!AP```8(```%\```!F0```7@```&@@``!=``$
XXM``6V```%2```!3````6&```%9@``!1X```3T```$U@``!*H```2>```$9```@
XXM`_@```/````$D@``!(0```1V```$/````U@```..```"U````H0```(F```#)
XXM?````L(```)R```"%````?````#V```!`@```4X```$4````-`````,``!(4U
XXM```,:```"C@```HB```(D```"'@```A@```(3```"#(```@6```(````!^8`#
XXM``?*```'N```!Z@```>.```'<@``!UP```="```'*@``!PH```,,```"\@``^
XXM!(P```1^```$<```!%8```0V```#[@```U(```)(```!R````80```%X```!R
XXM:@```5P```$^```!+````1P```$.```!"````/P```#N````W@```&0```!>R
XXM````3````$8````:````#@````@````"`````````_`````#7T9I;F1487-KM
XXM```````(C`````)?1G)E94UE;0``"'0````#7T%L;&]C365M```````(7```B
XXM``-?0W5R<F5N=$1I<@````A(`````E]%>$YE>'0````(+`````)?17AA;6ENH
XXM90``"!`````"7U5N3&]C:P````?\`````E],;V-K```````'X`````)?4V5E\
XXM:P``````!\0````"7T]U='!U=`````>T`````E]);G!U=``````'I`````)?@
XXM5W)I=&4`````!X@````"7U)E860```````=L`````E]#;&]S90`````'6```@
XXM``)?3W!E;@``````!SP````"7W!U=&-H87(```<<`````2Y,-0````<>````&
XXM`2Y,,P````<<`````2Y,,@````<B`````2Y,,0````<V`````E]P<FEN=&8`$
XXM```&_`````$N3#0````&_@````$N3#,````&_`````$N3#(````'`@````$N*
XXM3#$````'&`````)S8U]P=70`````!O@````#<W1U9F9#:&%R```````&^```1
XXM``)P<U]E;7!T>0``!NX````"7U]D;W!R;G0```:L`````G!S7W-I>F4````&U
XXMT@````-P<U]C;VUM;VX```````;<`````````_(```/J````T@`A``$`````8
XXM``````````#_______________\`````````````````````````````````T
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM`````````````````````````````````````````````````````````````
XXM````````````````````"B\J"B`J("``("`@("5L<PH`("HO``P*`#\`4T18"
XXM("T@4VEM<&QE($1O8W5M96YT($5X=')A8W1O<@H`0V]P>7)I9VAT("A#*2`Q:
XXM.3@X($)R>6%N($9O<F0*``I5<V%G93H@4T18(#YO=71F:6QE(&EN9FEL92!;J
XXM:6YF:6QE+BXN70H`)6QC```@("`@("`@("`H*"@H*"`@("`@("`@("`@("`@$
XXM("`@($@0$!`0$!`0$!`0$!`0$!"$A(2$A(2$A(2$$!`0$!`0$(&!@8&!@0$!8
XXM`0$!`0$!`0$!`0$!`0$!`0$!$!`0$!`0@H*"@H*"`@("`@("`@("`@("`@("<
XXM`@("`@(0$!`0("`@("`@("`@("@H*"@H("`@("`@("`@("`@("`@("`@2!`0Z
XXM$!`0$!`0$!`0$!`0$(2$A(2$A(2$A(00$!`0$!`0@8&!@8&!`0$!`0$!`0$!W
XXM`0$!`0$!`0$!`0$0$!`0$!""@H*"@H("`@("`@("`@("`@("`@("`@("`A`0_
XXM$!`@````*@`C/P`````H*3\E(WPJ`````_`````!+DPT`````C`````````#A
XX!\A`@B
XX``
XXend
XXsize 6976
SHAR_EOF
if test 9804 -ne "`wc -c SDX.uu`"
then
echo shar: error transmitting SDX.uu '(should have been 9804 characters)'
fi
# End of shell archive
exit 0