1. Paul Sexton
  2. clod

Source

clod / doc / clod-doc.org

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
#+TITLE: The CLOD package
#+AUTHOR: CLOD
#+EMAIL: your@email.here
#+LINK: hs http://www.lispworks.com/reference/HyperSpec//%s
#+STARTUP: showall
#+OPTIONS: toc:3 H:10 @:t tags:nil

# link target 2: <<clod>>
# link target: <<package clod>>


* Internal Package: =clod=                                               :package:

- Uses:
    [[package common-lisp][common-lisp]], [[package iterate][iterate]], [[package
    closer-mop][closer-mop]], [[package cl-ppcre][cl-ppcre]]
- Used by:
    None.
*** Description


CLOD is a tool for creating documentation for Common Lisp programs.
CLOD examines a loaded package and writes information about all the
symbols defined within that package, to a file.

The output file is in org format. Org is a simple but powerful 'wiki-like'
markup language that is understood by *Org-mode*, a powerful outliner, personal
wiki and organiser that runs within Emacs. Org-mode can export
org-format files to numerous other formats, including HTML, LaTeX, PDF,
DocBook, and plain text.

More information:
- Emacs :: [[http://www.gnu.org/software/emacs]] (if you program CL, you don't
  need to be told what Emacs is)
- Org mode :: [[http://orgmode.org/]]

*** Why use CLOD?


- You can use org markup within docstrings (easy for humans to read) to
  create subsections, bulleted lists, hyperlinks within the document or
  to external URLs, etc.
- Easy export to multiple file formats: text, HTML, LaTeX -> PDF...
- You can edit the output within Emacs, which is already the IDE of most
  CL programmers.
- Org has many cool tricks. Some examples of useful things you can put in
  docstrings:
  - Include an entire file and format as plain text:
    : #+INCLUDE: "filename" quote
  - Include an entire file with common lisp syntax highlighting
    : #+INCLUDE: "filename.lisp" src lisp
  - Timestamps and datestamps:
    : {{{ modification-time(%r) }}}
    {{{modification-time(%r)}}}
    : {{{ date(%Y-%m-%d) }}}
    {{{date(%Y-%m-%d)}}}
  - Define text macros, use with ={{{macro(arg1,arg2)}}}=
    : #+MACRO: foo Replacement text $1 $2
  - Embed any LaTeX code directly (no special markup needed)
  - Embed any HTML code (special markup needed)
  - Automatic syntax highlighting of source code examples in exported
    documents, eg:
#+BEGIN_SRC lisp
 (defun hello (a &key b)
    (print "Hello, world!"))
#+END_SRC

*** Dependencies


- ASDF
- Closer-MOP: http://common-lisp.net/project/closer/
- Iterate: http://common-lisp.net/project/iterate/
- CL-PPCRE: http://weitz.de/cl-ppcre/

*** How to use


1. Install CLOD somewhere ASDF can find it.
2. Load CLOD with =(asdf:oos 'asdf:load-op :clod)=
3. Load the package or packages for which you wish to produce documentation,
   eg: =(asdf:oos 'asdf:load-op :mypkg)=
4. Run =(clod:document-package :mypkg nil)= and you will see the documentation
   as a string, returned by [[document-package]].
5. Run =(clod:document-package :mypkg "filename.org")= and the same
   documentation will be written to 'filename.org'.
6. Load filename.org into Emacs. Export to HTML with =M-x org-export=, or press
   C-c C-e to be presented with a menu of export options.

*** Writing the documentation


All documentation produced by CLOD is obtained by introspection, i.e.  the
running CL process examining itself. If a symbol has an associated docstring,
it will be used by CLOD to produce the documentation for that symbol.

Within documentation strings, you can use org mode markup. This is a simple,
human-readable markup language similar to the type of markup used for wiki
editing and forum posting. See the Org
[[http://orgmode.org/manual/Markup.html][manual]] for more information. Also see
the docstrings in the CLOD source code, which use org markup.

Some special points to note:
- Outline headings are used to structure org documents. These headings
  begin with one or more asterisks at the start of the line. Thus, if you
  want a large docstring to be divided into subsections, the heading for
  each subsection should be a line that starts with one or more asterisks (*),
  then a space, then the title of the heading.
- These headings will automatically be correctly 'indented' for their location
  in the structure of the final document. The whole document is one outline,
  and any given docstring will usually be appearing 2 or 3 levels deep within
  that outline. However, CLOD finds all heading lines within docstrings and
  increases the number of asterisks appropriately.
- An extra blank line is also automatically inserted after headings within
  docstrings, allowing you to save screen space in the docstring itself.
- By default, many docstrings are inserted within a subsection titled
  'Description'. However, if you don't want this to happen, but rather want
  the docstring to define its own heading names, make sure that the very first
  thing in the docstring is a heading (straight after the opening quote).
- Some symbol names used by common lisp can conflict with the markup used
  by org mode. For example, =*global-variable*=: asterisks are interpreted
  by org mode as signifying bold text. CLOD catches these in headings and
  auto-generated documentation, but not within doc strings, where you will
  need to surround the offending symbol with =equals signs=.
- *Hyperlinks* are created using
  : [[double square brackets]]
  Any text surrounded by these brackets will link to the same text (case
  insensitive) surrounded by <<double angle brackets>>. CLOD uses this to define
  hyperlinks for all symbols in the package. Every symbol MYSYMBOL has:
  1. A hyperlink =<<function MYSYMBOL>>= if MYSYMBOL is a function,
     =<<variable MYSYMBOL>>= if it is a global variable, etc.
  2. A hyperlink =<<MYSYMBOL>>= which will either link to MYSYMBOL's documentation,
     or to a 'disambiguation section' if the same symbol has multiple meanings
     (eg there is both a function and a variable called MYSYMBOL).
- Org mode has the ability to use Emacs' font-lock mode to produce source code
  snippets that are correctly syntax highlighted for any major mode.
  To use this normally requires surrounding the code with #+BEGIN_SRC ... #+END_SRC.
  CLOD provides a shortcut: Any lines within docstrings that begin with three
  semicolons ;;; are assumed to be example lisp source code. The first 3
  semicolons are removed and the rest of the line is syntax highlighted.

*** Example


Here is the docstring for [[document-package]].

: * Usage
: : (document-package PKG FILE/STREAM &key AUTO-LINKS
: :      LINES-BETWEEN-SECTIONS BRIEF-METHODS TITLE
: :      AUTHOR EMAIL)
: * Arguments
: - PKG :: A package name or package object.
: - FILE/STREAM :: A string (filename), stream object, or =NIL=.
: - AUTO-LINKS :: Boolean.
: - LINES-BETWEEN-SECTIONS :: Boolean.
: - BRIEF-METHODS :: Boolean.
: - TITLE :: A string.
: - AUTHOR :: A string.
: - EMAIL :: A string.
: * Returns
: A string, or nil.
: * Description
: Produce documentation for the package =PKG=.
: 
: The documentation's destination depends on the value of =FILE/STREAM=:
: - =STRING=: documentation is written to the file named by the string.
: - =STREAM=: documentation is written to the already existing stream.
: - =NIL=: documentation is written to a string, which is then returned by
:   this function.
: 
: Explanation of optional arguments:
: - =TITLE=, =AUTHOR= and =EMAIL= specify the document title, the name of
:   the author, and the email address of the author.
: - If =AUTO-LINKS= is non-nil, *all* occurrences of symbol names within the
:   text of docstrings will be interpreted as hyperlinks, regardless of
:   whether they are marked up as hyperlinks.
: - If LINES-BETWEEN-SECTIONS is nil, do not output a horizontal line before
:   each new section of documentation.
: - If BRIEF-METHODS is nil, document individual methods with their own
:   sections, just like functions and generic functions. Most people put
:   'method' documentation in the docstrings of their generic functions, but
:   if you set docstrings for individual methods then set this to nil.
: 
: * See also
: - [[document-packages]]

*** Limitations


- There is no portable way to access the lambda lists of functions. Thus, you need
  to spell these out in function docstrings.

** Classes

-----
# link target 2: <<..3c..foo..3e..>>
# link target: <<class ..3c..foo..3e..>>


*** Internal Class: =<foo>=                                                  :class:


**** Inheritance

- Parent classes:
    [[class standard-object][standard-object]]
- Precedence list:
    [[class ..3c..foo..3e..][<foo>]], [[class standard-object][standard-object]],
    [[class t][t]]
- Direct subclasses:
    None.


**** Description

Not documented.


**** Direct Slots

# link target 2: <<myslot>>
# link target: <<slot myslot>>


***** Internal Slot: =myslot=                                                   :slot:

- Value type: =t=
- Initial value: =NIL=
- Initargs: none
- Allocation: instance







** Types

-----
# link target 2: <<..3d..entity..3d..>>
# link target: <<type ..3d..entity..3d..>>


*** Internal Type: ==entity==                                                 :type:

The type 'entity' can have any of several different symbols as its value.
Each value is a different kind of 'meaning' which a symbol can have within
a package. For example, =:function= is a function, =:class= is a class,
and so on.




** Constants

-----
# link target 2: <<..2b..alphabet..2b..>>
# link target: <<constant ..2b..alphabet..2b..>>


*** Internal Constant: =+alphabet+=                                       :constant:


**** Value

: (#\A #\B #\C #\D #\E #\F #\G #\H #\I #\J #\K #\L #\M #\N #\O #\P #\Q #\R #\S
: #\T #\U #\V #\W #\X #\Y #\Z)

Type: =cons=


**** Description

List of uppercase letters (characters) from A to Z.





** Global Variables

-----
# link target 2: <<*alphabet*>>
# link target: <<variable *alphabet*>>


*** Internal Variable: =*alphabet*=                                       :variable:


**** Value

: (#\A #\B #\C #\D #\E #\F #\G #\H #\I #\J #\K #\L #\M #\N #\O #\P #\Q #\R #\S
: #\T #\U #\V #\W #\X #\Y #\Z)

Type: =cons=


**** Description

List of uppercase letters (characters) from A to Z.



-----
# link target 2: <<*ambiguities*>>
# link target: <<variable *ambiguities*>>


*** Internal Variable: =*ambiguities*=                                    :variable:


**** Value

: #<HASH-TABLE :TEST EQL size 0/60 #x2643595E>

Type: =hash-table=


**** Description

Hash table created during package documentation. Stores all
symbols which have multiple 'meanings' within the package.



-----
# link target 2: <<*auto-links*>>
# link target: <<variable *auto-links*>>


*** Internal Variable: =*auto-links*=                                     :variable:


**** Value

: NIL

Type: =null=


**** Description

If true, all occurrences of package symbols anywhere in the documentation
will be turned into hyperlinks, even if they are not marked up as such.



-----
# link target 2: <<*brief-methods*>>
# link target: <<variable *brief-methods*>>


*** Internal Variable: =*brief-methods*=                                  :variable:


**** Value

: T

Type: =boolean=


**** Description

If true, most documentation for methods is assumed to be found in the docstring
for their generic function. A generic function's methods are therefore described
in a very brief format (bulleted list).

If false, each method receives its own section, just like other functions.



-----
# link target 2: <<*document-author*>>
# link target: <<variable *document-author*>>


*** Internal Variable: =*document-author*=                                :variable:


**** Value

: "CLOD"

Type: =simple-base-string=


**** Description

The author of the document. A string.



-----
# link target 2: <<*document-email*>>
# link target: <<variable *document-email*>>


*** Internal Variable: =*document-email*=                                 :variable:


**** Value

: "your@email.here"

Type: =simple-base-string=


**** Description

The email address of the document's author. A string.



-----
# link target 2: <<*document-title*>>
# link target: <<variable *document-title*>>


*** Internal Variable: =*document-title*=                                 :variable:


**** Value

: "The CLOD package"

Type: =simple-base-string=


**** Description

The title of the document. A string.



-----
# link target 2: <<*heading-char*>>
# link target: <<variable *heading-char*>>


*** Internal Variable: =*heading-char*=                                   :variable:


**** Value

: #\*

Type: =standard-char=


**** Description

Character used at the beginning of lines to signify headings and
subheadings. Should not be changed.



-----
# link target 2: <<*heading-level*>>
# link target: <<variable *heading-level*>>


*** Internal Variable: =*heading-level*=                                  :variable:


**** Value

: 4

Type: =integer=


**** Description

Number of levels 'deep' within the outline. Used when creating
headings for sections and subsections.



-----
# link target 2: <<*hyperspec-root*>>
# link target: <<variable *hyperspec-root*>>


*** Internal Variable: =*hyperspec-root*=                                 :variable:


**** Value

: "http://www.lispworks.com/reference/HyperSpec/"

Type: =simple-base-string=


**** Description

URL or directory where the Hyperspec is found. Not currently
implemented.



-----
# link target 2: <<*left-margin*>>
# link target: <<variable *left-margin*>>


*** Internal Variable: =*left-margin*=                                    :variable:


**** Value

: 0

Type: =bit=


**** Description

Width of the current 'left margin', in spaces.



-----
# link target 2: <<*line-width*>>
# link target: <<variable *line-width*>>


*** Internal Variable: =*line-width*=                                     :variable:


**** Value

: 80

Type: =integer=


**** Description

Width to which paragraphs are wrapped, in characters.



-----
# link target 2: <<*lines-between-sections*>>
# link target: <<variable *lines-between-sections*>>


*** Internal Variable: =*lines-between-sections*=                         :variable:


**** Value

: T

Type: =boolean=


**** Description

If true, sections of the document will be separated by horizontal lines.



-----
# link target 2: <<*out*>>
# link target: <<variable *out*>>


*** Internal Variable: =*out*=                                            :variable:


**** Value

: #<BASIC-FILE-CHARACTER-OUTPUT-STREAM ("/home/paul/lisp/clod/clod-doc.org"/4
: ISO-8859-1) #x26433BB6>

Type: =basic-file-character-output-stream=


**** Description

Global variable that is bound to the output stream used by CLOD
while writing documentation.



-----
# link target 2: <<*unsafe-html-chars*>>
# link target: <<variable *unsafe-html-chars*>>


*** Internal Variable: =*unsafe-html-chars*=                              :variable:


**** Value

: (#\< #\> #\= #\% #\? #\+ #\$ #\/ #\& #\@ #\, #\{ #\} #\^ #\~)

Type: =cons=


**** Description

List of characters which are unsafe within HTML links and anchors, and
which need to be converted to a safe representation.

See also: [[html-safe-string]].



-----
# link target 2: <<*unsafe-symbol-strings*>>
# link target: <<variable *unsafe-symbol-strings*>>


*** Internal Variable: =*unsafe-symbol-strings*=                          :variable:


**** Value

: (("^\\*" . "\\*") ("^/" . "\\/") ("^\\+" . "\\+") ("^_" . "\\_") ("^=" .
: "\\="))

Type: =cons=


**** Description

Alist of (REGEX . REPLACEMENT). Used to ensure that symbols do not
contain any characters which org will misinterpret as formatting directives.



-----
# link target 2: <<ff>>
# link target: <<variable ff>>


*** Internal Variable: =ff=                                               :variable:


**** Value

: #<COMMON-LISP:STANDARD-CLASS <FOO>>

Type: =standard-class=


**** Description

Not documented.





** Macros

-----
# link target 2: <<do-own-symbols>>
# link target: <<macro do-own-symbols>>


*** Internal Macro: =do-own-symbols=                                         :macro:

**** Usage

: (do-own-symbols (VAR PKG)
:    ...body...)
**** Arguments

- VAR :: symbol naming a variable that will be bound to each symbol in turn.
- PKG :: a package.
**** Description

Iterate through all the non-imported symbols in the package =PKG=.
=BODY= is executed once for each such symbol, with =VAR= bound to each
symbol in turn.


-----
# link target 2: <<write-indented>>
# link target: <<macro write-indented>>


*** Internal Macro: =write-indented=                                         :macro:

**** Usage

: (write-indented (INDENT)
:    ...body...)
**** Arguments

- INDENT :: An integer.
**** Return Value

Ignored.
**** Description

All text that is written within the body of the form will be indented
a further =INDENT= spaces from the left margin.


-----
# link target 2: <<writing-bulleted-list>>
# link target: <<macro writing-bulleted-list>>


*** Internal Macro: =writing-bulleted-list=                                  :macro:

Not documented.


-----
# link target 2: <<writing-section>>
# link target: <<macro writing-section>>


*** Internal Macro: =writing-section=                                        :macro:

Not documented.


-----
# link target 2: <<writing-section-for-symbol>>
# link target: <<macro writing-section-for-symbol>>


*** Internal Macro: =writing-section-for-symbol=                             :macro:

Not documented.




** Functions

-----
# link target 2: <<docpkg>>
# link target: <<function docpkg>>


*** Internal Function: =docpkg=                                           :function:

Not documented.


-----
# link target 2: <<docpkg-file>>
# link target: <<function docpkg-file>>


*** Internal Function: =docpkg-file=                                      :function:

Not documented.


-----
# link target 2: <<document-package>>
# link target: <<function document-package>>


*** External Function: =document-package=                                 :function:

**** Usage

: (document-package PKG FILE/STREAM &key AUTO-LINKS
:      LINES-BETWEEN-SECTIONS BRIEF-METHODS TITLE
:      AUTHOR EMAIL)
**** Arguments

- PKG :: A package name or package object.
- FILE/STREAM :: A string (filename), stream object, or =NIL=.
- AUTO-LINKS :: Boolean.
- LINES-BETWEEN-SECTIONS :: Boolean.
- BRIEF-METHODS :: Boolean.
- TITLE :: A string.
- AUTHOR :: A string.
- EMAIL :: A string.
**** Returns

A string, or nil.
**** Description

Produce documentation for the package =PKG=.

The documentation's destination depends on the value of =FILE/STREAM=:
- =STRING=: documentation is written to the file named by the string.
- =STREAM=: documentation is written to the already existing stream.
- =NIL=: documentation is written to a string, which is then returned by
  this function.

Explanation of optional arguments:
- =TITLE=, =AUTHOR= and =EMAIL= specify the document title, the name of
  the author, and the email address of the author.
- If =AUTO-LINKS= is non-nil, *all* occurrences of symbol names within the
  text of docstrings will be interpreted as hyperlinks, regardless of
  whether they are marked up as hyperlinks.
- If LINES-BETWEEN-SECTIONS is nil, do not output a horizontal line before
  each new section of documentation.
- If BRIEF-METHODS is nil, document individual methods with their own
  sections, just like functions and generic functions. Most people put
  'method' documentation in the docstrings of their generic functions, but
  if you set docstrings for individual methods then set this to nil.

**** See also

- [[document-packages]]


-----
# link target 2: <<document-package-contents>>
# link target: <<function document-package-contents>>


*** Internal Function: =document-package-contents=                        :function:

**** Usage

: (document-package-contents PKG [ACCESSIBILITIES])
**** Arguments

- PKG :: A package name or package object.
- ACCESSIBILITIES :: A list containing zero or more of the symbols
  =:external= or =:internal=.
**** Return Value

Ignored.
**** Description

Writes documentation for all symbols contained within the package =PKG=.
Does not write documentation for the actual package object.


-----
# link target 2: <<document-packages>>
# link target: <<function document-packages>>


*** External Function: =document-packages=                                :function:

**** Usage

: (document-packages PACKAGES FILE/STREAM &key AUTO-LINKS
:      LINES-BETWEEN-SECTIONS BRIEF-METHODS TITLE
:      AUTHOR EMAIL)
**** Arguments

- PACKAGES :: A list of package objects, or symbols naming packages.
- FILE/STREAM :: A string (filename), stream object, or =NIL=.
**** Returns

A string, or nil.
**** Description

Produces documentation for all the packages in =PACKAGES=, within a
single file.
See [[document-package]] for more details.


-----
# link target 2: <<entity-..3e..string>>
# link target: <<function entity-..3e..string>>


*** Internal Function: =entity->string=                                   :function:

**** Usage

: (entity->string ENTITY)
**** Arguments

- ENTITY :: An [[..3d..entity..3d..][=entity=]].
**** Returns

A string.
**** Description

Given an entity, returns a string that can be used to describe that
entity type in human-readable form, in headings, etc.


-----
# link target 2: <<entity-..3e..tag>>
# link target: <<function entity-..3e..tag>>


*** Internal Function: =entity->tag=                                      :function:

**** Usage

: (entity->tag ENTITY)
**** Arguments

- ENTITY :: An [[..3d..entity..3d..][=entity=]].
**** Returns

A string.
**** Description

Given an entity, returns a string that can be used as a *tag* denoting that
entity type in org mode. See [[http://orgmode.org/manual/Tags.html]] for
information on tags.


-----
# link target 2: <<html-safe-string>>
# link target: <<function html-safe-string>>


*** Internal Function: =html-safe-string=                                 :function:

Usage
: (html-safe-string STR)
**** Arguments

- STR :: A string.
**** Returns

A string.
**** Description


Given a string which is intended as a link target, return a copy in which we
remove or alter any unsafe characters that will stop the link working properly
when the document is exported to HTML.
**** See Also

- [[*unsafe-html-chars*]]


-----
# link target 2: <<list-..3e..string-with-commas>>
# link target: <<function list-..3e..string-with-commas>>


*** Internal Function: =list->string-with-commas=                         :function:

**** Usage

: (list->string-with-commas LS)
**** Arguments

- LS :: A list of values.
**** Returns

A string.
**** Description

Given a list of arbitrary values, returns a string consisting of the
printed representations of those values, separated by commas and spaces.
**** Example

#+BEGIN_SRC lisp
 (list->string-with-commas '(a b 123))

 => "A, B, 123"
#+END_SRC


-----
# link target 2: <<list-all-direct-slots>>
# link target: <<function list-all-direct-slots>>


*** Internal Function: =list-all-direct-slots=                            :function:

**** Usage

: (list-all-direct-slots CLASSES)
**** Arguments

- CLASSES :: A list of class objects.
**** Return Value

A list of SLOT-DEFINITION instances.
**** Description

Return a list of all the direct SLOT-DEFINITION instances defined
for all the classes in CLASSES.


-----
# link target 2: <<list-all-indirect-slots>>
# link target: <<function list-all-indirect-slots>>


*** Internal Function: =list-all-indirect-slots=                          :function:

**** Usage

: (list-all-indirect-slots CLASSES)
**** Arguments

- CLASSES :: A list of class objects.
**** Return Value

A list of SLOT-DEFINITION instances.
**** Description

Return a list of all the indirect SLOT-DEFINITION instances defined
for all the classes in CLASSES.


-----
# link target 2: <<list-all-slot-accessors>>
# link target: <<function list-all-slot-accessors>>


*** Internal Function: =list-all-slot-accessors=                          :function:

**** Usage

: (list-all-slot-accessors CLASSES)
**** Arguments

- CLASSES :: A list of class objects.
**** Return Value

A list of generic functions.
**** Description

Return a list of all the reader and writer generic functions associated
with all the slots of the classes in CLASSES.


-----
# link target 2: <<make-class-link>>
# link target: <<function make-class-link>>


*** Internal Function: =make-class-link=                                  :function:

Not documented.


-----
# link target 2: <<make-package-link>>
# link target: <<function make-package-link>>


*** Internal Function: =make-package-link=                                :function:

Not documented.


-----
# link target 2: <<make-specialised-lambda-list>>
# link target: <<function make-specialised-lambda-list>>


*** Internal Function: =make-specialised-lambda-list=                     :function:

**** Usage

: (make-specialised-lambda-list TERMS SPECS)
**** Arguments

- TERMS :: Unspecialised version of the lambda list (a list of symbols).
- SPECS :: List of class names on which a particular method is
  specialised.
**** Returns

A list.
**** Description

Given an unspecialised lambda list and a list of specialisers, reconstruct
the specialised lambda list and return it.


-----
# link target 2: <<make-target>>
# link target: <<function make-target>>


*** Internal Function: =make-target=                                      :function:

Not documented.


-----
# link target 2: <<org-safe-symbol>>
# link target: <<function org-safe-symbol>>


*** Internal Function: =org-safe-symbol=                                  :function:

**** Usage

: (org-safe-symbol SYM)
**** Arguments

- SYM :: A symbol.
**** Return Value

A string.
**** Description

Given the symbol SYM, return a string that represents SYM in a form that is
human-readable and where org will not be confused by any characters that
might represent markup instructions.


-----
# link target 2: <<safe-symbol>>
# link target: <<function safe-symbol>>


*** Internal Function: =safe-symbol=                                      :function:

Not documented.


-----
# link target 2: <<simple-type..3f..>>
# link target: <<function simple-type..3f..>>


*** Internal Function: =simple-type?=                                     :function:

**** Usage

: (simple-type? SYM)
**** Arguments

- SYM :: A symbol.
**** Return Value

Boolean.
**** Description

Returns =T= if =SYM= names a non-class type, such as can be
defined by [[deftype]].


-----
# link target 2: <<symbol-accessibility>>
# link target: <<function symbol-accessibility>>


*** Internal Function: =symbol-accessibility=                             :function:

**** Usage

: (symbol-accessibility SYM [PKG])
**** Arguments

- SYM :: A symbol.
- PKG :: A package.
**** Returns

One of =:inherited, :internal, :external= or =nil=.
**** Description

Returns a symbol describing how the symbol =SYM= is accessible within
the package =PKG=. If =SYM= is exported by =PKG= then the function
returns =:external=, and so on.


-----
# link target 2: <<type-..3e..string>>
# link target: <<function type-..3e..string>>


*** Internal Function: =type->string=                                     :function:

Not documented.


-----
# link target 2: <<uses-for-symbol>>
# link target: <<function uses-for-symbol>>


*** Internal Function: =uses-for-symbol=                                  :function:

**** Usage

: (uses-for-symbol SYM)
**** Arguments

- SYM :: A symbol.
**** Return Value

A list of [[..3d..entity..3d..][=entity=]] values.
**** Description

Given a symbol =SYM=, return a list of entity values, describing the
different meanings/bindings of =SYM= within its home package.


-----
# link target 2: <<word-wrap>>
# link target: <<function word-wrap>>


*** Internal Function: =word-wrap=                                        :function:

**** Usage

: (word-wrap TEXT &key WIDTH RESPECT-NEWLINES RESPECT-HYPHENS
:    EXCLUDE-START-CHAR EXCLUDE-END-CHAR)
**** Arguments

- TEXT :: A string.
- WIDTH :: An integer. The maximum length of lines once TEXT is wrapped.
Default is 80.
- RESPECT-NEWLINES :: Boolean. Should newline characters within the string
be treated as unbreakable? (=NIL=)
- RESPECT-HYPHENS :: Boolean. Should we refrain from breaking hyphenated
words? (=NIL=)
- EXCLUDE-START-CHAR :: A character, or nil.
- EXCLUDE-END-CHAR :: A character, or nil.

**** Return Value

A list of strings.

**** Description

Given a string =TEXT=, breaks the string into a series of
smaller strings, none of which is longer than =WIDTH=. Returns the list of
strings.

If =EXCLUDE-START-CHAR= and =EXCLUDE-END-CHAR= are supplied, those characters
will be treated as demarcating sections of the string whose length is to
be ignored (treated as zero).


-----
# link target 2: <<wrap-and-write>>
# link target: <<function wrap-and-write>>


*** Internal Function: =wrap-and-write=                                   :function:

Not documented.


-----
# link target 2: <<wrap-and-write-code>>
# link target: <<function wrap-and-write-code>>


*** Internal Function: =wrap-and-write-code=                              :function:

Not documented.


-----
# link target 2: <<write-bullet-point>>
# link target: <<function write-bullet-point>>


*** Internal Function: =write-bullet-point=                               :function:

Not documented.


-----
# link target 2: <<write-chapter>>
# link target: <<function write-chapter>>


*** Internal Function: =write-chapter=                                    :function:

**** Usage

: (write-chapter SYMLIST ENTITY TITLE)
**** Arguments

- SYMLIST :: A list of symbols.
- ENTITY :: An [[..3d..entity..3d..][=entity=]].
- TITLE :: A string.
**** Return Value

Ignored.
**** Description

Writes the section of the document which describes all entities of
type =ENTITY=. =SYMLIST= should be a list of all the symbols that
name such entities.


-----
# link target 2: <<write-disambiguation>>
# link target: <<function write-disambiguation>>


*** Internal Function: =write-disambiguation=                             :function:

Not documented.


-----
# link target 2: <<write-docstring>>
# link target: <<function write-docstring>>


*** Internal Function: =write-docstring=                                  :function:

**** Usage

: (write-docstring STR &key LEVELS DEFAULT)
**** Arguments

- STR :: A docstring.
- LEVELS :: How many levels deep in the outline is
  this docstring?
- DEFAULT :: A string. Default text, used if =STR= is =NIL=.
**** Return Value

Ignored.
**** Description

Writes the docstring STR to the document. Before doing this, processes
the docstring to:
- Demote headings
- Make all hyperlinks safe for org mode and HTML export
- Convert lines beginning with ';;;' to syntax-highlighting markup.


-----
# link target 2: <<write-docstring-section>>
# link target: <<function write-docstring-section>>


*** Internal Function: =write-docstring-section=                          :function:

Not documented.


-----
# link target 2: <<write-heading>>
# link target: <<function write-heading>>


*** Internal Function: =write-heading=                                    :function:

Not documented.


-----
# link target 2: <<write-index>>
# link target: <<function write-index>>


*** Internal Function: =write-index=                                      :function:

Not documented.


-----
# link target 2: <<write-list-as-paragraph>>
# link target: <<function write-list-as-paragraph>>


*** Internal Function: =write-list-as-paragraph=                          :function:

Not documented.


-----
# link target 2: <<write-out>>
# link target: <<function write-out>>


*** Internal Function: =write-out=                                        :function:

Not documented.


-----
# link target 2: <<write-preamble>>
# link target: <<function write-preamble>>


*** Internal Function: =write-preamble=                                   :function:

**** Usage

: (write-preamble)
**** Arguments

None.
**** Return Value

Ignored.
**** Description

Writes some org instructions, intended to be placed at the start of the
document. These specify the document's author, title, and set some
export options.




** Generic Functions

-----
# link target 2: <<document>>
# link target: <<generic-function document>>


*** Internal Generic Function: =document=                                  :generic:


**** Usage

(=document= sym doctype)

***** Arguments

- SYM :: a symbol.
- DOCTYPE :: an [[..3d..entity..3d..][=entity=]].
***** Returns:

Ignored.
***** Description

Writes a section documenting the [[..3d..entity..3d..][=entity=]] named =SYM= which is of entity type
=DOCTYPE=.

**** Methods

- (=document= (slot [[class direct-slot-definition][=direct-slot-definition=]])
  (doctype (eql :slot)))
- (=document= (slot [[class effective-slot-definition][=effective-slot
  definition=]]) (doctype (eql :slot)))
- (=document= :around (slot [[class slot-definition][=slot-definition=]])
  (doctype (eql :slot)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :structure)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :class)))
- (=document= (m [[class standard-method][=common-lisp:standard-method=]])
  (doctype (eql :method)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :slot-accessor)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :slot-writer)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :slot-reader)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :generic)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :constant)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :variable)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :type)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :macro)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql :function)))
- (=document= :before (sym [[class symbol][=symbol=]]) (doctype [[class
  t][=t=]]))
- (=document= :after (sym [[class symbol][=symbol=]]) (doctype [[class
  t][=t=]]))
- (=document= (slot [[class direct-slot-definition][=direct-slot-definition=]])
  (doctype (eql slot)))
- (=document= (slot [[class effective-slot-definition][=effective-slot
  definition=]]) (doctype (eql slot)))
- (=document= :around (slot [[class slot-definition][=slot-definition=]])
  (doctype (eql slot)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql class)))
- (=document= (m [[class standard-method][=standard-method=]]) (doctype (eql
  method)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql slot-accessor)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql slot-writer)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql slot-reader)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql generic)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql constant)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql var)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql macro)))
- (=document= (sym [[class symbol][=symbol=]]) (doctype (eql function)))



-----
# link target 2: <<make-link>>
# link target: <<generic-function make-link>>


*** Internal Generic Function: =make-link=                                 :generic:


**** Usage

(=make-link= target entity &key text)

***** Arguments

- TARGET :: A symbol, string, or other value that constitutes the target of the
  link.
- ENTITY :: An [[..3d..entity..3d..][=entity=]].
- TEXT :: An optional string, used for the appearance of the link. The default
  is a direct textual representation of =TARGET=.
***** Returns

A string.
***** Description

Given a target and text, return a string that will be interpreted by org mode as
a hyperlink leading to the documentation for =TARGET=.

**** Methods

- (=make-link= (c [[class eql-specializer][=eql-specializer=]]) (entity (eql
  :class)) &key text)
- (=make-link= (o [[class standard-object][=standard-object=]]) (entity (eql
  :class)) &key text)
- (=make-link= (c [[class class][=class=]]) (entity (eql :class)) &key text)
- (=make-link= (sym [[class symbol][=symbol=]]) (entity [[class t][=t=]]) &key
  text)
- (=make-link= (str [[class string][=string=]]) (entity [[class
  symbol][=symbol=]]) &key text)
- (=make-link= (str [[class string][=string=]]) (entity [[class null][=null=]])
  &key text)





** Index

 [[index NONALPHABETIC][NONALPHABETIC]]  [[index F][F]]  [[index E][E]] 
[[index O][O]]  [[index D][D]]  [[index C][C]]  [[index M][M]]  [[index W][W]] 
[[index L][L]]  [[index U][U]]  [[index T][T]]  [[index S][S]]  [[index H][H]] 



*** Nonalphabetic


# link target: <<index NONALPHABETIC>>
- [[variable *alphabet*][=*alphabet*=]], Variable
- [[variable *ambiguities*][=*ambiguities*=]], Variable
- [[variable *auto-links*][=*auto-links*=]], Variable
- [[variable *brief-methods*][=*brief-methods*=]], Variable
- [[variable *document-author*][=*document-author*=]], Variable
- [[variable *document-email*][=*document-email*=]], Variable
- [[variable *document-title*][=*document-title*=]], Variable
- [[variable *heading-char*][=*heading-char*=]], Variable
- [[variable *heading-level*][=*heading-level*=]], Variable
- [[variable *hyperspec-root*][=*hyperspec-root*=]], Variable
- [[variable *left-margin*][=*left-margin*=]], Variable
- [[variable *line-width*][=*line-width*=]], Variable
- [[variable *lines-between-sections*][=*lines-between-sections*=]], Variable
- [[variable *out*][=*out*=]], Variable
- [[variable *unsafe-html-chars*][=*unsafe-html-chars*=]], Variable
- [[variable *unsafe-symbol-strings*][=*unsafe-symbol-strings*=]], Variable
- [[constant ..2b..alphabet..2b..][=+alphabet+=]], Constant
- [[class ..3c..foo..3e..][=<foo>=]], Class
- [[type ..3d..entity..3d..][==entity==]], Type



*** C


# link target: <<index C>>
- [[package ccl][=ccl=]], Package
- [[package clod][=clod=]], Package
- [[package common-lisp][=common-lisp=]], Package



*** D


# link target: <<index D>>
- [[macro do-own-symbols][=do-own-symbols=]], Macro
- [[function docpkg][=docpkg=]], Function
- [[function docpkg-file][=docpkg-file=]], Function
- [[generic-function document][=document=]], Generic Function
- [[function document-package][=document-package=]], Function
- [[function document-package-contents][=document-package-contents=]], Function
- [[function document-packages][=document-packages=]], Function



*** E


# link target: <<index E>>
- [[function entity-..3e..string][=entity->string=]], Function
- [[function entity-..3e..tag][=entity->tag=]], Function



*** F


# link target: <<index F>>
- [[variable ff][=ff=]], Variable



*** H


# link target: <<index H>>
- [[function html-safe-string][=html-safe-string=]], Function



*** L


# link target: <<index L>>
- [[function list-..3e..string-with-commas][=list->string-with-commas=]],
  Function
- [[function list-all-direct-slots][=list-all-direct-slots=]], Function
- [[function list-all-indirect-slots][=list-all-indirect-slots=]], Function
- [[function list-all-slot-accessors][=list-all-slot-accessors=]], Function



*** M


# link target: <<index M>>
- [[function make-class-link][=make-class-link=]], Function
- [[generic-function make-link][=make-link=]], Generic Function
- [[function make-package-link][=make-package-link=]], Function
- [[function make-specialised-lambda-list][=make-specialised-lambda-list=]],
  Function
- [[function make-target][=make-target=]], Function



*** O


# link target: <<index O>>
- [[function org-safe-symbol][=org-safe-symbol=]], Function



*** S


# link target: <<index S>>
- [[function safe-symbol][=safe-symbol=]], Function
- [[function simple-type..3f..][=simple-type?=]], Function
- [[function symbol-accessibility][=symbol-accessibility=]], Function



*** T


# link target: <<index T>>
- [[package target][=target=]], Package
- [[function type-..3e..string][=type->string=]], Function



*** U


# link target: <<index U>>
- [[function uses-for-symbol][=uses-for-symbol=]], Function



*** W


# link target: <<index W>>
- [[function word-wrap][=word-wrap=]], Function
- [[function wrap-and-write][=wrap-and-write=]], Function
- [[function wrap-and-write-code][=wrap-and-write-code=]], Function
- [[function write-bullet-point][=write-bullet-point=]], Function
- [[function write-chapter][=write-chapter=]], Function
- [[function write-disambiguation][=write-disambiguation=]], Function
- [[function write-docstring][=write-docstring=]], Function
- [[function write-docstring-section][=write-docstring-section=]], Function
- [[function write-heading][=write-heading=]], Function
- [[macro write-indented][=write-indented=]], Macro
- [[function write-index][=write-index=]], Function
- [[function write-list-as-paragraph][=write-list-as-paragraph=]], Function
- [[function write-out][=write-out=]], Function
- [[function write-preamble][=write-preamble=]], Function
- [[macro writing-bulleted-list][=writing-bulleted-list=]], Macro
- [[macro writing-section][=writing-section=]], Macro
- [[macro writing-section-for-symbol][=writing-section-for-symbol=]], Macro