Changeset 13858


Ignore:
Timestamp:
02/06/12 11:21:48 (9 years ago)
Author:
rschlatte
Message:

Manual: fix grovel.lisp, add to Makefile (not run by default)

... also create new versions of generated files.

Location:
trunk/abcl/doc/manual
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/doc/manual/Makefile

    r13802 r13858  
    22all: abcl.pdf
    33
    4 abcl.pdf: abcl.tex abcl.bib
     4abcl.pdf: abcl.tex abcl.bib java.tex extensions.tex threads.tex
    55  pdflatex abcl.tex
    66  bibtex abcl
     
    99  pdflatex abcl.tex
    1010
     11grovel:
     12  abcl --batch --noinform --load "grovel.lisp" --eval '(progn (grovel-docstrings-as-tex (find-package :java)) (grovel-docstrings-as-tex (find-package :extensions)) (grovel-docstrings-as-tex (find-package :threads)))'
     13
    1114clean:
    1215  rm -f *.aux *.bbl *.blg *.idx *.ilg *.ind *.log *.out *.toc abcl.pdf
  • trunk/abcl/doc/manual/extensions.tex

    r13690 r13858  
    1 \subsection{Exported Symbols from the EXTENSIONS package}
    2 
    31\paragraph{}
    42\label{EXTENSIONS:COMPILE-FILE-IF-NEEDED}
     
    75
    86\begin{adjustwidth}{5em}{5em}
    9 NOT-DOCUMENTED
     7not-documented
    108\end{adjustwidth}
    119
     
    1614
    1715\begin{adjustwidth}{5em}{5em}
    18 NOT-DOCUMENTED
     16not-documented
    1917\end{adjustwidth}
    2018
     
    2523
    2624\begin{adjustwidth}{5em}{5em}
    27 NOT-DOCUMENTED
     25not-documented
    2826\end{adjustwidth}
    2927
     
    3432
    3533\begin{adjustwidth}{5em}{5em}
    36 NOT-DOCUMENTED
     34not-documented
    3735\end{adjustwidth}
    3836
     
    4341
    4442\begin{adjustwidth}{5em}{5em}
    45 NOT-DOCUMENTED
     43not-documented
    4644\end{adjustwidth}
    4745
     
    5250
    5351\begin{adjustwidth}{5em}{5em}
    54 NOT-DOCUMENTED
     52not-documented
    5553\end{adjustwidth}
    5654
     
    6159
    6260\begin{adjustwidth}{5em}{5em}
    63 NOT-DOCUMENTED
     61not-documented
    6462\end{adjustwidth}
    6563
     
    7068
    7169\begin{adjustwidth}{5em}{5em}
    72 NOT-DOCUMENTED
     70not-documented
    7371\end{adjustwidth}
    7472
     
    7977
    8078\begin{adjustwidth}{5em}{5em}
    81 NOT-DOCUMENTED
     79not-documented
    8280\end{adjustwidth}
    8381
     
    8886
    8987\begin{adjustwidth}{5em}{5em}
    90 Kills the process.
     88not-documented
    9189\end{adjustwidth}
    9290
     
    9795
    9896\begin{adjustwidth}{5em}{5em}
    99 NOT-DOCUMENTED
     97not-documented
    10098\end{adjustwidth}
    10199
     
    106104
    107105\begin{adjustwidth}{5em}{5em}
    108 NOT-DOCUMENTED
     106not-documented
    109107\end{adjustwidth}
    110108
     
    115113
    116114\begin{adjustwidth}{5em}{5em}
    117 NOT-DOCUMENTED
     115not-documented
    118116\end{adjustwidth}
    119117
     
    124122
    125123\begin{adjustwidth}{5em}{5em}
    126 NOT-DOCUMENTED
     124not-documented
    127125\end{adjustwidth}
    128126
     
    133131
    134132\begin{adjustwidth}{5em}{5em}
    135 NOT-DOCUMENTED
     133not-documented
    136134\end{adjustwidth}
    137135
     
    142140
    143141\begin{adjustwidth}{5em}{5em}
    144 NOT-DOCUMENTED
     142not-documented
    145143\end{adjustwidth}
    146144
     
    151149
    152150\begin{adjustwidth}{5em}{5em}
    153 NOT-DOCUMENTED
     151not-documented
     152\end{adjustwidth}
     153
     154\paragraph{}
     155\label{EXTENSIONS:CDR}
     156\index{CDR}
     157--- Macro: \textbf{\%cdr} [\textbf{extensions}] \textit{}
     158
     159\begin{adjustwidth}{5em}{5em}
     160not-documented
    154161\end{adjustwidth}
    155162
     
    160167
    161168\begin{adjustwidth}{5em}{5em}
    162 NOT-DOCUMENTED
     169not-documented
    163170\end{adjustwidth}
    164171
     
    169176
    170177\begin{adjustwidth}{5em}{5em}
    171 NOT-DOCUMENTED
     178not-documented
    172179\end{adjustwidth}
    173180
     
    178185
    179186\begin{adjustwidth}{5em}{5em}
    180 NOT-DOCUMENTED
     187not-documented
    181188\end{adjustwidth}
    182189
     
    187194
    188195\begin{adjustwidth}{5em}{5em}
    189 NOT-DOCUMENTED
     196not-documented
    190197\end{adjustwidth}
    191198
     
    196203
    197204\begin{adjustwidth}{5em}{5em}
    198 NOT-DOCUMENTED
     205not-documented
    199206\end{adjustwidth}
    200207
     
    205212
    206213\begin{adjustwidth}{5em}{5em}
    207 NOT-DOCUMENTED
     214not-documented
    208215\end{adjustwidth}
    209216
     
    214221
    215222\begin{adjustwidth}{5em}{5em}
    216 NOT-DOCUMENTED
     223not-documented
    217224\end{adjustwidth}
    218225
     
    223230
    224231\begin{adjustwidth}{5em}{5em}
    225 NOT-DOCUMENTED
     232not-documented
    226233\end{adjustwidth}
    227234
     
    232239
    233240\begin{adjustwidth}{5em}{5em}
    234 NOT-DOCUMENTED
     241not-documented
     242\end{adjustwidth}
     243
     244\paragraph{}
     245\label{EXTENSIONS:CADDR}
     246\index{CADDR}
     247--- Macro: \textbf{\%caddr} [\textbf{extensions}] \textit{}
     248
     249\begin{adjustwidth}{5em}{5em}
     250not-documented
    235251\end{adjustwidth}
    236252
     
    241257
    242258\begin{adjustwidth}{5em}{5em}
    243 NOT-DOCUMENTED
     259not-documented
    244260\end{adjustwidth}
    245261
     
    250266
    251267\begin{adjustwidth}{5em}{5em}
    252 NOT-DOCUMENTED
     268not-documented
    253269\end{adjustwidth}
    254270
     
    259275
    260276\begin{adjustwidth}{5em}{5em}
    261 NOT-DOCUMENTED
     277not-documented
    262278\end{adjustwidth}
    263279
     
    268284
    269285\begin{adjustwidth}{5em}{5em}
    270 NOT-DOCUMENTED
     286not-documented
    271287\end{adjustwidth}
    272288
     
    277293
    278294\begin{adjustwidth}{5em}{5em}
    279 NOT-DOCUMENTED
     295not-documented
    280296\end{adjustwidth}
    281297
     
    286302
    287303\begin{adjustwidth}{5em}{5em}
    288 NOT-DOCUMENTED
     304not-documented
    289305\end{adjustwidth}
    290306
     
    295311
    296312\begin{adjustwidth}{5em}{5em}
    297 NOT-DOCUMENTED
     313not-documented
    298314\end{adjustwidth}
    299315
     
    304320
    305321\begin{adjustwidth}{5em}{5em}
    306 NOT-DOCUMENTED
     322not-documented
    307323\end{adjustwidth}
    308324
     
    313329
    314330\begin{adjustwidth}{5em}{5em}
    315 NOT-DOCUMENTED
     331not-documented
    316332\end{adjustwidth}
    317333
     
    322338
    323339\begin{adjustwidth}{5em}{5em}
    324 NOT-DOCUMENTED
     340not-documented
    325341\end{adjustwidth}
    326342
     
    331347
    332348\begin{adjustwidth}{5em}{5em}
    333 NOT-DOCUMENTED
     349not-documented
    334350\end{adjustwidth}
    335351
     
    358374
    359375\begin{adjustwidth}{5em}{5em}
    360 NOT-DOCUMENTED
     376not-documented
    361377\end{adjustwidth}
    362378
     
    367383
    368384\begin{adjustwidth}{5em}{5em}
    369 NOT-DOCUMENTED
     385not-documented
    370386\end{adjustwidth}
    371387
     
    376392
    377393\begin{adjustwidth}{5em}{5em}
    378 NOT-DOCUMENTED
     394not-documented
    379395\end{adjustwidth}
    380396
     
    385401
    386402\begin{adjustwidth}{5em}{5em}
    387 NOT-DOCUMENTED
     403not-documented
    388404\end{adjustwidth}
    389405
     
    394410
    395411\begin{adjustwidth}{5em}{5em}
    396 NOT-DOCUMENTED
     412not-documented
    397413\end{adjustwidth}
    398414
     
    403419
    404420\begin{adjustwidth}{5em}{5em}
    405 NOT-DOCUMENTED
     421not-documented
    406422\end{adjustwidth}
    407423
     
    412428
    413429\begin{adjustwidth}{5em}{5em}
    414 NOT-DOCUMENTED
     430not-documented
    415431\end{adjustwidth}
    416432
     
    421437
    422438\begin{adjustwidth}{5em}{5em}
    423 NOT-DOCUMENTED
     439not-documented
    424440\end{adjustwidth}
    425441
     
    430446
    431447\begin{adjustwidth}{5em}{5em}
    432 NOT-DOCUMENTED
     448not-documented
    433449\end{adjustwidth}
    434450
     
    439455
    440456\begin{adjustwidth}{5em}{5em}
    441 NOT-DOCUMENTED
     457not-documented
    442458\end{adjustwidth}
    443459
     
    448464
    449465\begin{adjustwidth}{5em}{5em}
    450 NOT-DOCUMENTED
     466not-documented
    451467\end{adjustwidth}
    452468
     
    457473
    458474\begin{adjustwidth}{5em}{5em}
    459 NOT-DOCUMENTED
     475not-documented
    460476\end{adjustwidth}
    461477
     
    466482
    467483\begin{adjustwidth}{5em}{5em}
    468 NOT-DOCUMENTED
     484not-documented
    469485\end{adjustwidth}
    470486
     
    475491
    476492\begin{adjustwidth}{5em}{5em}
    477 NOT-DOCUMENTED
     493not-documented
    478494\end{adjustwidth}
    479495
     
    484500
    485501\begin{adjustwidth}{5em}{5em}
    486 NOT-DOCUMENTED
     502not-documented
    487503\end{adjustwidth}
    488504
     
    493509
    494510\begin{adjustwidth}{5em}{5em}
    495 NOT-DOCUMENTED
     511not-documented
    496512\end{adjustwidth}
    497513
     
    502518
    503519\begin{adjustwidth}{5em}{5em}
    504 NOT-DOCUMENTED
     520not-documented
    505521\end{adjustwidth}
    506522
     
    511527
    512528\begin{adjustwidth}{5em}{5em}
    513 NOT-DOCUMENTED
     529not-documented
    514530\end{adjustwidth}
    515531
     
    520536
    521537\begin{adjustwidth}{5em}{5em}
    522 Creates a weak reference to 'obj'.
     538not-documented
    523539\end{adjustwidth}
    524540
     
    529545
    530546\begin{adjustwidth}{5em}{5em}
    531 NOT-DOCUMENTED
     547not-documented
    532548\end{adjustwidth}
    533549
     
    538554
    539555\begin{adjustwidth}{5em}{5em}
    540 NOT-DOCUMENTED
     556not-documented
    541557\end{adjustwidth}
    542558
     
    547563
    548564\begin{adjustwidth}{5em}{5em}
    549 NOT-DOCUMENTED
     565not-documented
    550566\end{adjustwidth}
    551567
     
    598614
    599615\begin{adjustwidth}{5em}{5em}
    600 NOT-DOCUMENTED
     616not-documented
    601617\end{adjustwidth}
    602618
     
    607623
    608624\begin{adjustwidth}{5em}{5em}
    609 NOT-DOCUMENTED
     625not-documented
    610626\end{adjustwidth}
    611627
     
    616632
    617633\begin{adjustwidth}{5em}{5em}
    618 NOT-DOCUMENTED
     634not-documented
    619635\end{adjustwidth}
    620636
     
    625641
    626642\begin{adjustwidth}{5em}{5em}
    627 NOT-DOCUMENTED
     643not-documented
    628644\end{adjustwidth}
    629645
     
    634650
    635651\begin{adjustwidth}{5em}{5em}
    636 NOT-DOCUMENTED
     652not-documented
    637653\end{adjustwidth}
    638654
     
    645661
    646662\begin{adjustwidth}{5em}{5em}
    647 NOT-DOCUMENTED
     663not-documented
    648664\end{adjustwidth}
    649665
     
    654670
    655671\begin{adjustwidth}{5em}{5em}
    656 NOT-DOCUMENTED
     672not-documented
    657673\end{adjustwidth}
    658674
     
    663679
    664680\begin{adjustwidth}{5em}{5em}
    665 NOT-DOCUMENTED
     681not-documented
    666682\end{adjustwidth}
    667683
     
    672688
    673689\begin{adjustwidth}{5em}{5em}
    674 NOT-DOCUMENTED
     690not-documented
    675691\end{adjustwidth}
    676692
     
    681697
    682698\begin{adjustwidth}{5em}{5em}
    683 NOT-DOCUMENTED
     699not-documented
     700\end{adjustwidth}
     701
     702\paragraph{}
     703\label{EXTENSIONS:CAR}
     704\index{CAR}
     705--- Macro: \textbf{\%car} [\textbf{extensions}] \textit{}
     706
     707\begin{adjustwidth}{5em}{5em}
     708not-documented
    684709\end{adjustwidth}
    685710
     
    690715
    691716\begin{adjustwidth}{5em}{5em}
    692 NOT-DOCUMENTED
     717not-documented
    693718\end{adjustwidth}
    694719
     
    699724
    700725\begin{adjustwidth}{5em}{5em}
    701 NOT-DOCUMENTED
     726not-documented
    702727\end{adjustwidth}
    703728
     
    708733
    709734\begin{adjustwidth}{5em}{5em}
    710 NOT-DOCUMENTED
     735not-documented
    711736\end{adjustwidth}
    712737
     
    717742
    718743\begin{adjustwidth}{5em}{5em}
    719 NOT-DOCUMENTED
     744not-documented
    720745\end{adjustwidth}
    721746
     
    726751
    727752\begin{adjustwidth}{5em}{5em}
    728 NOT-DOCUMENTED
     753not-documented
    729754\end{adjustwidth}
    730755
     
    735760
    736761\begin{adjustwidth}{5em}{5em}
    737 NOT-DOCUMENTED
     762not-documented
    738763\end{adjustwidth}
    739764
     
    744769
    745770\begin{adjustwidth}{5em}{5em}
    746 NOT-DOCUMENTED
     771not-documented
    747772\end{adjustwidth}
    748773
     
    762787
    763788\begin{adjustwidth}{5em}{5em}
    764 NOT-DOCUMENTED
     789not-documented
    765790\end{adjustwidth}
    766791
     
    780805
    781806\begin{adjustwidth}{5em}{5em}
    782 NOT-DOCUMENTED
     807not-documented
    783808\end{adjustwidth}
    784809
     
    789814
    790815\begin{adjustwidth}{5em}{5em}
    791 NOT-DOCUMENTED
     816not-documented
    792817\end{adjustwidth}
    793818
     
    798823
    799824\begin{adjustwidth}{5em}{5em}
    800 NOT-DOCUMENTED
     825not-documented
    801826\end{adjustwidth}
    802827
     
    816841
    817842\begin{adjustwidth}{5em}{5em}
    818 NOT-DOCUMENTED
     843not-documented
    819844\end{adjustwidth}
    820845
     
    825850
    826851\begin{adjustwidth}{5em}{5em}
    827 NOT-DOCUMENTED
     852not-documented
     853\end{adjustwidth}
     854
     855\paragraph{}
     856\label{EXTENSIONS:CADR}
     857\index{CADR}
     858--- Macro: \textbf{\%cadr} [\textbf{extensions}] \textit{}
     859
     860\begin{adjustwidth}{5em}{5em}
     861not-documented
    828862\end{adjustwidth}
    829863
     
    843877
    844878\begin{adjustwidth}{5em}{5em}
    845 NOT-DOCUMENTED
     879not-documented
    846880\end{adjustwidth}
    847881
     
    852886
    853887\begin{adjustwidth}{5em}{5em}
    854 NOT-DOCUMENTED
     888not-documented
    855889\end{adjustwidth}
    856890
     
    861895
    862896\begin{adjustwidth}{5em}{5em}
    863 NOT-DOCUMENTED
     897not-documented
    864898\end{adjustwidth}
    865899
     
    870904
    871905\begin{adjustwidth}{5em}{5em}
    872 NOT-DOCUMENTED
     906not-documented
    873907\end{adjustwidth}
    874908
     
    888922
    889923\begin{adjustwidth}{5em}{5em}
    890 NOT-DOCUMENTED
     924not-documented
    891925\end{adjustwidth}
    892926
     
    906940
    907941\begin{adjustwidth}{5em}{5em}
    908 NOT-DOCUMENTED
     942not-documented
    909943\end{adjustwidth}
    910944
     
    924958
    925959\begin{adjustwidth}{5em}{5em}
    926 NOT-DOCUMENTED
     960not-documented
    927961\end{adjustwidth}
    928962
     
    933967
    934968\begin{adjustwidth}{5em}{5em}
    935 NOT-DOCUMENTED
     969not-documented
    936970\end{adjustwidth}
    937971
     
    951985
    952986\begin{adjustwidth}{5em}{5em}
    953 NOT-DOCUMENTED
     987not-documented
    954988\end{adjustwidth}
    955989
     
    960994
    961995\begin{adjustwidth}{5em}{5em}
    962 NOT-DOCUMENTED
     996not-documented
    963997\end{adjustwidth}
    964998
     
    9691003
    9701004\begin{adjustwidth}{5em}{5em}
    971 NOT-DOCUMENTED
     1005not-documented
    9721006\end{adjustwidth}
    9731007
     
    9871021
    9881022\begin{adjustwidth}{5em}{5em}
    989 NOT-DOCUMENTED
     1023not-documented
    9901024\end{adjustwidth}
    9911025
     
    9961030
    9971031\begin{adjustwidth}{5em}{5em}
    998 NOT-DOCUMENTED
     1032not-documented
    9991033\end{adjustwidth}
    10001034
     
    10051039
    10061040\begin{adjustwidth}{5em}{5em}
    1007 NOT-DOCUMENTED
     1041not-documented
    10081042\end{adjustwidth}
    10091043
     
    10141048
    10151049\begin{adjustwidth}{5em}{5em}
    1016 NOT-DOCUMENTED
     1050not-documented
    10171051\end{adjustwidth}
    10181052
     
    10231057
    10241058\begin{adjustwidth}{5em}{5em}
    1025 NOT-DOCUMENTED
     1059not-documented
    10261060\end{adjustwidth}
    10271061
     
    10321066
    10331067\begin{adjustwidth}{5em}{5em}
    1034 NOT-DOCUMENTED
     1068not-documented
    10351069\end{adjustwidth}
    10361070
     
    10411075
    10421076\begin{adjustwidth}{5em}{5em}
    1043 NOT-DOCUMENTED
     1077not-documented
    10441078\end{adjustwidth}
    10451079
     
    10501084
    10511085\begin{adjustwidth}{5em}{5em}
    1052 NOT-DOCUMENTED
     1086not-documented
    10531087\end{adjustwidth}
    10541088
     
    10691103
    10701104\begin{adjustwidth}{5em}{5em}
    1071 NOT-DOCUMENTED
     1105not-documented
    10721106\end{adjustwidth}
    10731107
     
    10781112
    10791113\begin{adjustwidth}{5em}{5em}
    1080 NOT-DOCUMENTED
     1114not-documented
    10811115\end{adjustwidth}
    10821116
     
    10871121
    10881122\begin{adjustwidth}{5em}{5em}
    1089 NOT-DOCUMENTED
     1123not-documented
    10901124\end{adjustwidth}
    10911125
     
    10961130
    10971131\begin{adjustwidth}{5em}{5em}
    1098 NOT-DOCUMENTED
     1132not-documented
    10991133\end{adjustwidth}
    11001134
     
    11051139
    11061140\begin{adjustwidth}{5em}{5em}
    1107 NOT-DOCUMENTED
     1141not-documented
    11081142\end{adjustwidth}
    11091143
     
    11141148
    11151149\begin{adjustwidth}{5em}{5em}
    1116 NOT-DOCUMENTED
    1117 \end{adjustwidth}
    1118 
     1150not-documented
     1151\end{adjustwidth}
     1152
  • trunk/abcl/doc/manual/grovel.lisp

    r13689 r13858  
    1 #-abcl We're only grovelling ABCL docstrings here.
     1
    22(defun grovel-docstrings-as-tex (&optional (package (find-package :java)))
    33  (let ((output-file (format nil "~A.tex" (string-downcase (package-name package)))))
     
    77         :doing (format stream "~&~A~%~%" (symbol-as-tex symbol))))))
    88
     9(require :asdf)
     10
    911(asdf:load-system 'swank) ;; XXX Does this load the SWANK-BACKEND package as well
     12
     13(defun texify-string (string &optional remove)
     14  (with-output-to-string (s)
     15    (loop for char across string
     16         do (if (find char '(#\& #\% #\#))
     17                (unless remove
     18                  (write-char #\\ s)
     19                  (write-char char s))
     20                (write-char char s)))))
     21
     22(defun texify (thing)
     23  "Return STRING with LaTeX-sensitive characters escaped.
     24Downcase symbol names but leave strings alone."
     25  (cond ((listp thing)
     26         (format nil "~A" (mapcar #'texify thing)))
     27        ((stringp thing) (texify-string thing))
     28        ((symbolp thing) (texify-string (string-downcase (symbol-name thing))))))
    1029
    1130(defun arglist-as-tex (symbol)
    1231  (handler-case
    1332      (loop :for arg :in (arglist symbol)
    14          :collecting
    15          (format nil
    16                  ;;; XXX should really check the entire input for TeX escapes
    17                  (if (and (symbolp arg)
    18                           (or (string= (subseq (symbol-name arg) 0 1) #\&)
    19                               (string= (subseq (symbol-name arg) 0 1) #\%)))
    20                      "\\~A"
    21                      "~A")
    22                  (if (symbolp arg)
    23                      (string-downcase (symbol-name arg))
    24                      (format nil "~(~A~)" arg))))
     33         :collecting (texify arg))
    2534    (t (e)
    2635      (progn (warn "Failed to form arglist for ~A: ~A" symbol e)
     
    7382              package-name (string-downcase
    7483                            (package-name (find-package (symbol-package symbol)))))
    75         (format nil "~&\\paragraph{}~&\\label{~A:~A}~&\\index{~A}~&--- ~A: \\textbf{~A} [\\textbf{~A}] \\textit{~A}~%~%\\begin{adjustwidth}{5em}{5em}~&~A~&\\end{adjustwidth}"
    76                 (package-name (find-package (symbol-package symbol)))
    77                 (symbol-name symbol)
    78                 (symbol-name symbol)
     84        (format nil "~&\\paragraph{}
     85\\label{~A:~A}
     86\\index{~A}
     87--- ~A: \\textbf{~A} [\\textbf{~A}] \\textit{~A}
     88
     89\\begin{adjustwidth}{5em}{5em}
     90~A
     91\\end{adjustwidth}"
     92                (texify-string (package-name (find-package (symbol-package symbol))) t)
     93                (texify-string (symbol-name symbol) t)
     94                (texify-string (symbol-name symbol) t)
    7995                (cdr (assoc type *type-alist*))
    80                 symbol-name
    81                 package-name
     96                (texify symbol-name)
     97                (texify package-name)
    8298                (if arglist arglist "")
    83                 (if documentation documentation "")))))
     99                (if documentation (texify documentation) "")))))
    84100               
    85101               
  • trunk/abcl/doc/manual/java.tex

    r13690 r13858  
    1 \subsection{Exported Symbols from the JAVA package}
    21\paragraph{}
    32\label{JAVA:JAVA-EXCEPTION-CAUSE}
     
    65
    76\begin{adjustwidth}{5em}{5em}
    8 Returns the cause of JAVA-EXCEPTION. (The cause is the Java Throwable
    9   object that caused JAVA-EXCEPTION to be signalled.)
     7not-documented
    108\end{adjustwidth}
    119
     
    4543
    4644\begin{adjustwidth}{5em}{5em}
    47 NOT-DOCUMENTED
     45not-documented
    4846\end{adjustwidth}
    4947
     
    8583
    8684\paragraph{}
     85\label{JAVA:JINSTANCE-OF-P}
     86\index{JINSTANCE-OF-P}
     87--- Function: \textbf{jinstance-of-p} [\textbf{java}] \textit{obj class}
     88
     89\begin{adjustwidth}{5em}{5em}
     90OBJ is an instance of CLASS (or one of its subclasses)
     91\end{adjustwidth}
     92
     93\paragraph{}
     94\label{JAVA:JSTATIC-RAW}
     95\index{JSTATIC-RAW}
     96--- Function: \textbf{jstatic-raw} [\textbf{java}] \textit{method class \&rest args}
     97
     98\begin{adjustwidth}{5em}{5em}
     99Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
     100\end{adjustwidth}
     101
     102\paragraph{}
     103\label{JAVA:DEFINE-JAVA-CLASS}
     104\index{DEFINE-JAVA-CLASS}
     105--- Macro: \textbf{define-java-class} [\textbf{java}] \textit{}
     106
     107\begin{adjustwidth}{5em}{5em}
     108not-documented
     109\end{adjustwidth}
     110
     111\paragraph{}
     112\label{JAVA:JCLASS-OF}
     113\index{JCLASS-OF}
     114--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
     115
     116\begin{adjustwidth}{5em}{5em}
     117not-documented
     118\end{adjustwidth}
     119
     120\paragraph{}
    87121\label{JAVA:JRUN-EXCEPTION-PROTECTED}
    88122\index{JRUN-EXCEPTION-PROTECTED}
     
    94128
    95129\paragraph{}
    96 \label{JAVA:JINSTANCE-OF-P}
    97 \index{JINSTANCE-OF-P}
    98 --- Function: \textbf{jinstance-of-p} [\textbf{java}] \textit{obj class}
    99 
    100 \begin{adjustwidth}{5em}{5em}
    101 OBJ is an instance of CLASS (or one of its subclasses)
    102 \end{adjustwidth}
    103 
    104 \paragraph{}
    105130\label{JAVA:JMETHOD-NAME}
    106131\index{JMETHOD-NAME}
     
    112137
    113138\paragraph{}
    114 \label{JAVA:JSTATIC-RAW}
    115 \index{JSTATIC-RAW}
    116 --- Function: \textbf{jstatic-raw} [\textbf{java}] \textit{method class \&rest args}
    117 
    118 \begin{adjustwidth}{5em}{5em}
    119 Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
    120 \end{adjustwidth}
    121 
    122 \paragraph{}
    123 \label{JAVA:JCLASS-OF}
    124 \index{JCLASS-OF}
    125 --- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
    126 
    127 \begin{adjustwidth}{5em}{5em}
    128 Returns the name of the Java class of OBJECT. If the NAME argument is
    129   supplied, verifies that OBJECT is an instance of the named class. The name
    130   of the class or nil is always returned as a second value.
    131 \end{adjustwidth}
    132 
    133 \paragraph{}
    134139\label{JAVA:GET-CURRENT-CLASSLOADER}
    135140\index{GET-CURRENT-CLASSLOADER}
     
    137142
    138143\begin{adjustwidth}{5em}{5em}
    139 NOT-DOCUMENTED
    140 \end{adjustwidth}
    141 
     144not-documented
     145\end{adjustwidth}
     146
     147\paragraph{}
     148\label{JAVA:JGET-PROPERTY-VALUE}
     149\index{JGET-PROPERTY-VALUE}
     150--- Function: \textbf{\%jget-property-value} [\textbf{java}] \textit{java-object property-name}
     151
     152\begin{adjustwidth}{5em}{5em}
     153Gets a JavaBeans property on JAVA-OBJECT.
     154SYSTEM-INTERNAL: Use jproperty-value instead.
     155\end{adjustwidth}
    142156
    143157\paragraph{}
     
    147161
    148162\begin{adjustwidth}{5em}{5em}
    149 NOT-DOCUMENTED
     163not-documented
    150164\end{adjustwidth}
    151165
     
    165179
    166180\begin{adjustwidth}{5em}{5em}
    167 NOT-DOCUMENTED
     181not-documented
    168182\end{adjustwidth}
    169183
     
    201215
    202216\begin{adjustwidth}{5em}{5em}
    203 NOT-DOCUMENTED
     217not-documented
     218\end{adjustwidth}
     219
     220\paragraph{}
     221\label{JAVA:JSET-PROPERTY-VALUE}
     222\index{JSET-PROPERTY-VALUE}
     223--- Function: \textbf{\%jset-property-value} [\textbf{java}] \textit{java-object property-name value}
     224
     225\begin{adjustwidth}{5em}{5em}
     226Sets a JavaBean property on JAVA-OBJECT.
     227SYSTEM-INTERNAL: Use (setf jproperty-value) instead.
    204228\end{adjustwidth}
    205229
     
    216240\label{JAVA:JNEW-RUNTIME-CLASS}
    217241\index{JNEW-RUNTIME-CLASS}
    218 --- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{}
    219 
    220 \begin{adjustwidth}{5em}{5em}
    221 NOT-DOCUMENTED
     242--- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{class-name \&rest args \&key (superclass java.lang.Object) interfaces constructors methods fields (access-flags (quote (public))) annotations}
     243
     244\begin{adjustwidth}{5em}{5em}
     245Creates and loads a Java class with methods calling Lisp closures
     246   as given in METHODS.  CLASS-NAME and SUPER-NAME are strings,
     247   INTERFACES is a list of strings, CONSTRUCTORS, METHODS and FIELDS are
     248   lists of constructor, method and field definitions.
     249
     250   Constructor definitions - currently NOT supported - are lists of the form
     251   (argument-types function \&optional super-invocation-arguments)
     252   where argument-types is a list of strings and function is a lisp function of
     253   (1+ (length argument-types)) arguments; the instance (`this') is passed in as
     254   the last argument. The optional super-invocation-arguments is a list of numbers
     255   between 1 and (length argument-types), where the number k stands for the kth argument
     256   to the just defined constructor. If present, the constructor of the superclass
     257   will be called with the appropriate arguments. E.g., if the constructor definition is
     258   (("java.lang.String" "int") \#'(lambda (string i this) ...) (2 1))
     259   then the constructor of the superclass with argument types (int, java.lang.String) will
     260   be called with the second and first arguments.
     261
     262   Method definitions are lists of the form
     263   (method-name return-type argument-types function \&key modifiers annotations)
     264   where method-name is a string, return-type and argument-types are strings or keywords for
     265   primitive types (:void, :int, etc.), and function is a Lisp function of minimum arity
     266   (1+ (length argument-types)); the instance (`this') is passed in as the first argument.
     267
     268   Field definitions are lists of the form (field-name type \&key modifiers annotations).
    222269\end{adjustwidth}
    223270
     
    250297
    251298\paragraph{}
     299\label{JAVA:JNEW}
     300\index{JNEW}
     301--- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
     302
     303\begin{adjustwidth}{5em}{5em}
     304Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
     305\end{adjustwidth}
     306
     307\paragraph{}
    252308\label{JAVA:JREGISTER-HANDLER}
    253309\index{JREGISTER-HANDLER}
     
    255311
    256312\begin{adjustwidth}{5em}{5em}
    257 NOT-DOCUMENTED
     313not-documented
    258314\end{adjustwidth}
    259315
     
    277333
    278334\paragraph{}
     335\label{JAVA:JARRAY-COMPONENT-TYPE}
     336\index{JARRAY-COMPONENT-TYPE}
     337--- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
     338
     339\begin{adjustwidth}{5em}{5em}
     340Returns the component type of the array type ATYPE
     341\end{adjustwidth}
     342
     343\paragraph{}
     344\label{JAVA:ADD-TO-CLASSPATH}
     345\index{ADD-TO-CLASSPATH}
     346--- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
     347
     348\begin{adjustwidth}{5em}{5em}
     349not-documented
     350\end{adjustwidth}
     351
     352\paragraph{}
    279353\label{JAVA:UNREGISTER-JAVA-EXCEPTION}
    280354\index{UNREGISTER-JAVA-EXCEPTION}
     
    286360
    287361\paragraph{}
    288 \label{JAVA:JNEW}
    289 \index{JNEW}
    290 --- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
    291 
    292 \begin{adjustwidth}{5em}{5em}
    293 Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
    294 \end{adjustwidth}
    295 
    296 \paragraph{}
    297 \label{JAVA:JRUNTIME-CLASS-EXISTS-P}
    298 \index{JRUNTIME-CLASS-EXISTS-P}
    299 --- Function: \textbf{jruntime-class-exists-p} [\textbf{java}] \textit{}
    300 
    301 \begin{adjustwidth}{5em}{5em}
    302 NOT-DOCUMENTED
    303 \end{adjustwidth}
    304 
    305 \paragraph{}
    306 \label{JAVA:JARRAY-COMPONENT-TYPE}
    307 \index{JARRAY-COMPONENT-TYPE}
    308 --- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
    309 
    310 \begin{adjustwidth}{5em}{5em}
    311 Returns the component type of the array type ATYPE
    312 \end{adjustwidth}
    313 
    314 \paragraph{}
    315 \label{JAVA:ADD-TO-CLASSPATH}
    316 \index{ADD-TO-CLASSPATH}
    317 --- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
    318 
    319 \begin{adjustwidth}{5em}{5em}
    320 NOT-DOCUMENTED
    321 \end{adjustwidth}
    322 
    323 \paragraph{}
    324362\label{JAVA:JOBJECT-LISP-VALUE}
    325363\index{JOBJECT-LISP-VALUE}
     
    336374
    337375\begin{adjustwidth}{5em}{5em}
    338 When called with one argument, returns the name of the Java class
    339   designated by CLASS-REF. When called with two arguments, tests
    340   whether CLASS-REF matches NAME.
     376not-documented
    341377\end{adjustwidth}
    342378
     
    365401
    366402\begin{adjustwidth}{5em}{5em}
    367 NOT-DOCUMENTED
     403not-documented
    368404\end{adjustwidth}
    369405
     
    374410
    375411\begin{adjustwidth}{5em}{5em}
    376 NOT-DOCUMENTED
     412not-documented
    377413\end{adjustwidth}
    378414
     
    383419
    384420\begin{adjustwidth}{5em}{5em}
    385 NOT-DOCUMENTED
     421not-documented
    386422\end{adjustwidth}
    387423
     
    448484
    449485\begin{adjustwidth}{5em}{5em}
    450 NOT-DOCUMENTED
     486not-documented
    451487\end{adjustwidth}
    452488
     
    485521      derived from the instance.
    486522
     523
    487524\end{adjustwidth}
    488525
     
    493530
    494531\begin{adjustwidth}{5em}{5em}
    495 NOT-DOCUMENTED
     532not-documented
    496533\end{adjustwidth}
    497534
     
    520557
    521558\begin{adjustwidth}{5em}{5em}
    522 NOT-DOCUMENTED
     559not-documented
    523560\end{adjustwidth}
    524561
     
    538575
    539576\begin{adjustwidth}{5em}{5em}
    540 NOT-DOCUMENTED
     577not-documented
    541578\end{adjustwidth}
    542579
     
    587624
    588625\paragraph{}
    589 \label{JAVA:JREDEFINE-METHOD}
    590 \index{JREDEFINE-METHOD}
    591 --- Function: \textbf{jredefine-method} [\textbf{java}] \textit{}
    592 
    593 \begin{adjustwidth}{5em}{5em}
    594 NOT-DOCUMENTED
    595 \end{adjustwidth}
    596 
    597 \paragraph{}
    598626\label{JAVA:JCLASS-FIELDS}
    599627\index{JCLASS-FIELDS}
     
    610638
    611639\begin{adjustwidth}{5em}{5em}
    612 NOT-DOCUMENTED
     640not-documented
    613641\end{adjustwidth}
    614642
     
    619647
    620648\begin{adjustwidth}{5em}{5em}
    621 NOT-DOCUMENTED
     649not-documented
    622650\end{adjustwidth}
    623651
     
    657685      derived from the instance.
    658686
     687
    659688\end{adjustwidth}
    660689
     
    710739
    711740\begin{adjustwidth}{5em}{5em}
    712 NOT-DOCUMENTED
     741not-documented
    713742\end{adjustwidth}
    714743
     
    737766
    738767\begin{adjustwidth}{5em}{5em}
    739 NOT-DOCUMENTED
     768not-documented
    740769\end{adjustwidth}
    741770
  • trunk/abcl/doc/manual/threads.tex

    r13690 r13858  
    1 \subsection{Exported Symbols from the THREADS package}
    2 
    31\paragraph{}
    42\label{THREADS:MAILBOX-EMPTY-P}
     
    75
    86\begin{adjustwidth}{5em}{5em}
    9 Returns non-NIL if the mailbox can be read from, NIL otherwise.
     7not-documented
    108\end{adjustwidth}
    119
     
    1614
    1715\begin{adjustwidth}{5em}{5em}
    18 NOT-DOCUMENTED
     16not-documented
    1917\end{adjustwidth}
    2018
     
    2523
    2624\begin{adjustwidth}{5em}{5em}
    27 NOT-DOCUMENTED
     25not-documented
    2826\end{adjustwidth}
    2927
     
    3432
    3533\begin{adjustwidth}{5em}{5em}
    36 NOT-DOCUMENTED
     34not-documented
    3735\end{adjustwidth}
    3836
     
    6159
    6260\begin{adjustwidth}{5em}{5em}
    63 NOT-DOCUMENTED
     61not-documented
    6462\end{adjustwidth}
    6563
     
    7068
    7169\begin{adjustwidth}{5em}{5em}
    72 NOT-DOCUMENTED
     70not-documented
    7371\end{adjustwidth}
    7472
     
    8886
    8987\begin{adjustwidth}{5em}{5em}
    90 NOT-DOCUMENTED
     88not-documented
    9189\end{adjustwidth}
    9290
     
    9492\label{THREADS:MAKE-MAILBOX}
    9593\index{MAKE-MAILBOX}
    96 --- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{}
    97 
    98 \begin{adjustwidth}{5em}{5em}
    99 NOT-DOCUMENTED
     94--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g2304220) NIL)}
     95
     96\begin{adjustwidth}{5em}{5em}
     97not-documented
    10098\end{adjustwidth}
    10199
     
    106104
    107105\begin{adjustwidth}{5em}{5em}
    108 NOT-DOCUMENTED
     106not-documented
    109107\end{adjustwidth}
    110108
     
    155153\label{THREADS:SYNCHRONIZED-ON}
    156154\index{SYNCHRONIZED-ON}
    157 --- NIL: \textbf{synchronized-on} [\textbf{threads}] \textit{}
    158 
    159 \begin{adjustwidth}{5em}{5em}
     155--- Special Operator: \textbf{synchronized-on} [\textbf{threads}] \textit{}
     156
     157\begin{adjustwidth}{5em}{5em}
     158not-documented
    160159\end{adjustwidth}
    161160
     
    173172\label{THREADS:MAKE-MUTEX}
    174173\index{MAKE-MUTEX}
    175 --- Function: \textbf{make-mutex} [\textbf{threads}] \textit{}
    176 
    177 \begin{adjustwidth}{5em}{5em}
    178 NOT-DOCUMENTED
     174--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g2304421) NIL)}
     175
     176\begin{adjustwidth}{5em}{5em}
     177not-documented
    179178\end{adjustwidth}
    180179
     
    185184
    186185\begin{adjustwidth}{5em}{5em}
    187 NOT-DOCUMENTED
     186not-documented
    188187\end{adjustwidth}
    189188
     
    194193
    195194\begin{adjustwidth}{5em}{5em}
    196 NOT-DOCUMENTED
     195not-documented
    197196\end{adjustwidth}
    198197
     
    213212
    214213\begin{adjustwidth}{5em}{5em}
    215 NOT-DOCUMENTED
     214not-documented
    216215\end{adjustwidth}
    217216
     
    222221
    223222\begin{adjustwidth}{5em}{5em}
    224 NOT-DOCUMENTED
     223not-documented
    225224\end{adjustwidth}
    226225
     
    231230
    232231\begin{adjustwidth}{5em}{5em}
    233 NOT-DOCUMENTED
    234 \end{adjustwidth}
    235 
     232not-documented
     233\end{adjustwidth}
     234
Note: See TracChangeset for help on using the changeset viewer.