[armedbear-devel] Pdfdoclet - Javadoc for ABCL in PDF format

[Sean Champ]

Hello!

In brief: Attached is a shell script for running pdfdoclet[6], a Javadoc 
doclet component that generates PDF format documentation, instead of 
HTML, when used with the javadoc tool. For sake of convenience, I was 
going to send the PDF format ABCL javadoc generated by pdfdoclet, but 
the resulting PDF file is 13.3 megs in size. Maybe the little utility 
shell script, as attached, could be enough.

The PDF javadoc could be useful, i think,  in the interest of studying 
ABCL's Java API - perhaps more intermediately, for modeling ABCL's Java 
API in UML - for instance, using  Modelio[1], Argo[2], or Papyrus[3], on 
the laptop, and Cubetto Mobile[4] on the tablet.

As an additional plug: As far as the PDF format itself, and PDF's 
annotation support, typically on mobile, i tend to prefer Goodreader[5]. 
It offers good support for PDF annotations and so on.


PDFDoclet can also be used from Ant. I'm not very well familiar with 
Ant, offhand. Of course, I notice that Ant is used in ABCL - will take a 
look...


Cheers!


[1] http://www.modeliosoft.com/
[2] http://argouml.tigris.org/
[3] http://www.eclipse.org/papyrus/
[4] http://www.semture.de/en/cubetto-mobile-en/overview
[5] http://www.goodiware.com/goodreader.html
[6] http://pdfdoclet.sourceforge.net/

<http://pdfdoclet.sourceforge.net/><http://www.semture.de/en/cubetto-mobile-en/overview><http://www.eclipse.org/papyrus/> 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.common-lisp.net/pipermail/armedbear-devel/attachments/20130721/c83f0155/attachment.html>
-------------- next part --------------
#!/bin/bash

## Shell script for running PDFDoclet from the command line
##
## see javadoc(1), also http://pdfdoclet.sourceforge.net/running.html
##
## Args:
##  1: PDF filename (optional, default javadoc.pdf)
##  2: source directory (optionall, default $PWD)
##  3: list of pacakges to generate documentation for (optional,
##     default is derived based on pathname semantics in the source
##     directory)

THISDIR=$(dirname $(realpath $0))


PDF="${1:-javadoc.pdf}"
shift
#echo PDF=$PDF

SRC="${1:-$PWD}"
shift
#echo SRC=$SRC

if [ -n "$1" ]; then
  PACKAGES="$1"
  shift
else
 PACKAGES="$(find "$SRC" -type d ! -path "*META-INF*" -a ! -path "*WEB-INF*" -printf "\n%P" |
	       sed 's|/|.|g')"
fi
#echo PACKAGES=$PACKAGES


CFG="${1:-$THISDIR/../share/pdfdoclet/default.properties}"
shift
#echo CFG=$CFG


JAVADOC=/usr/bin/javadoc
JAR=${THISDIR}/../share/java/pdfdoclet.jar
DOCLET=com.tarsec.javadoc.pdfdoclet.PDFDoclet

export CLASSPATH=$JAR

exec "${JAVADOC}" -docletpath "${JAR}" -doclet "${DOCLET}" \
    -pdf "${PDF}" -config "${CFG}" -sourcepath "${SRC}" $PACKAGES