Commit 38208a6e6b07c8d3e144632c33833e16023b410b
2001-01-11T09:27:49
* docs/docmaker.py: Minor improvements to reduce unwanted spaces and empty lines in output. * docs/docmaker.py: Improved script to generate table of contents and index pages. It also supports wildcards on non Unix systems. * include/freetype/*.h, include/freetype/cache/*.h: Updated comments to include section definitions/delimitations for the API Reference generator. * include/freetype/freetype.h: Moved declaration of `FT_Generic_Finalizer' and the `FT_Generic' structure to... * include/freetype/fttypes.h: here.
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 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777
diff --git a/ChangeLog b/ChangeLog
index ef0bfa0..c5a2e4f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,13 +1,22 @@
-2000-01-09 David Turner <david.turner@freetype.org>
+2001-01-10 Werner Lemberg <wl@gnu.org>
- * docs/docmaker.py: improved script to generate table of contents and
- index pages. it also supports wildcards on non Unix systems
+ * docs/docmaker.py: Minor improvements to reduce unwanted spaces
+ and empty lines in output.
- * include/freetype/*.h, include/freetype/cache/*.h: updated comments
- to include section definitions / delimitations for the API Reference
- generator..
+2001-01-09 David Turner <david.turner@freetype.org>
-2000-01-04 Werner Lemberg <wl@gnu.org>
+ * docs/docmaker.py: Improved script to generate table of contents
+ and index pages. It also supports wildcards on non Unix systems.
+
+ * include/freetype/*.h, include/freetype/cache/*.h: Updated comments
+ to include section definitions/delimitations for the API Reference
+ generator.
+
+ * include/freetype/freetype.h: Moved declaration of
+ `FT_Generic_Finalizer' and the `FT_Generic' structure to...
+ * include/freetype/fttypes.h: here.
+
+2001-01-04 Werner Lemberg <wl@gnu.org>
* include/freetype/ttnameid.h: Updated Unicode code range comments.
diff --git a/docs/docmaker.py b/docs/docmaker.py
index c3d69c4..752be46 100644
--- a/docs/docmaker.py
+++ b/docs/docmaker.py
@@ -10,7 +10,7 @@
import fileinput, sys, string, glob
-html_header = """
+html_header = """\
<html>
<header>
<title>FreeType 2 API Reference</title>
@@ -21,54 +21,39 @@ html_header = """
LI { text-align=justify }
</style>
</header>
-<body text="#000000"
- bgcolor="#FFFFFF"
- link="#0000EF"
- vlink="#51188E"
- alink="#FF0000">
+<body text=#000000
+ bgcolor=#FFFFFF
+ link=#0000EF
+ vlink=#51188E
+ alink=#FF0000>
<center><h1>FreeType 2 API Reference</h1></center>
"""
-html_footer = """
+html_footer = """\
</body>
-</html>
-"""
-
-section_title_header = """
-<center><h1>
-"""
+</html>"""
-section_title_footer = """
-</h1></center>
-"""
-
-
-code_header = """
-<font color=blue><pre>
-"""
+section_title_header = "<center><h1>"
+section_title_footer = "</h1></center>"
-code_footer = """
-</pre></font>
-"""
+code_header = "<font color=blue><pre>"
+code_footer = "</pre></font>"
para_header = "<p>"
para_footer = "</p>"
-block_header = """<center><hr width="750"><table width="750"><tr><td>"""
+block_header = "<center><hr width=75%><table width=75%><tr><td>"
block_footer = "</td></tr></table></center>"
-description_header = """<center><table width="650"><tr><td>"""
-description_footer = """</td></tr></table></center><br>"""
+description_header = "<center><table width=65%><tr><td>"
+description_footer = "</td></tr></table></center><br>"
-marker_header = """<center><table width="650" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>"""
+marker_header = "<center><table width=65% cellpadding=5><tr bgcolor=#EEEEFF><td><em><b>"
marker_inter = "</b></em></td></tr><tr><td>"
marker_footer = "</td></tr></table></center>"
-source_header = """<center><table width="650"><tr bgcolor="#D6E8FF" width="100%"><td><pre>
-"""
-source_footer = """</pre></table></center>
-<br>
-"""
+source_header = "<center><table width=65%><tr bgcolor=#D6E8FF width=100%><td><pre>"
+source_footer = "</pre></table></center><br>"
current_section = None
@@ -206,10 +191,14 @@ class DocCode:
while l > 0 and string.strip( self.lines[l - 1] ) == "":
l = l - 1
- print code_header
+ # the code footer should be directly appended to the last code
+ # line to avoid an additional blank line
+ #
+ sys.stdout.write( code_header )
for line in self.lines[0 : l]:
- print line
- print code_footer
+ sys.stdout.write( '\n' + line )
+ sys.stdout.write( code_footer )
+
#############################################################################
@@ -219,7 +208,6 @@ class DocCode:
#
# The paragraph is filled line by line by the parser.
#
-
class DocParagraph:
def __init__( self ):
@@ -229,13 +217,13 @@ class DocParagraph:
def add( self, line ):
# Get rid of unwanted spaces in the paragraph.
#
- # The following line is the same as
+ # The following two lines are the same as
#
# self.words.extend( string.split( line ) )
#
# but older Python versions don't have the `extend' attribute.
#
- last = len(self.words)
+ last = len( self.words )
self.words[last:last] = string.split( line )
@@ -287,6 +275,7 @@ class DocParagraph:
print para_footer
+
#############################################################################
#
# DocContent is used to store the content of a given marker.
@@ -320,8 +309,6 @@ class DocParagraph:
# The DocContent object is entirely built at creation time; you must
# pass a list of input text lines in the "lines_list" parameter.
#
-#
-
class DocContent:
def __init__( self, lines_list ):
@@ -390,7 +377,7 @@ class DocContent:
paragraph.add( line )
else:
- # we're in code mode...
+ # we are in code mode...
#
line = aline
@@ -454,7 +441,7 @@ class DocContent:
element.dump()
if field:
- print "</field> "
+ print "</field>"
def dump_html( self ):
@@ -475,7 +462,7 @@ class DocContent:
else:
if not in_table:
- print '<table cellpadding=4><tr valign=top><td>'
+ print "<table cellpadding=4><tr valign=top><td>"
in_table = 1
else:
print "</td></tr><tr valign=top><td>"
@@ -514,7 +501,7 @@ class DocContent:
-######################################################################################
+#############################################################################
#
#
# The DocBlock class is used to store a given comment block. It contains
@@ -527,9 +514,9 @@ class DocContent:
# "self.source" is simply a list of text lines taken from the
# uncommented source itself.
#
-# Finally, "self.name" is a simple identifier used to
-# uniquely identify the block. it is taken from the first word of the first
-# paragraphe of the first marker of a given block, i.e:
+# Finally, "self.name" is a simple identifier used to uniquely identify
+# the block. It is taken from the first word of the first
+# paragraph of the first marker of a given block, i.e:
#
# <Type> Goo
# <Description> Bla bla bla
@@ -539,13 +526,13 @@ class DocContent:
class DocBlock:
def __init__( self, block_line_list = [], source_line_list = [] ):
- self.items = [] # current ( marker, contents ) list
- self.section = None # section this block belongs to
-
- marker = None # current marker
- content = [] # current content lines list
- alphanum = string.letters + string.digits + "_"
- self.name = None
+ self.items = [] # current ( marker, contents ) list
+ self.section = None # section this block belongs to
+
+ marker = None # current marker
+ content = [] # current content lines list
+ alphanum = string.letters + string.digits + "_"
+ self.name = None
for line in block_line_list:
line2 = string.lstrip( line )
@@ -613,7 +600,7 @@ class DocBlock:
content = DocContent( lines )
self.items.append( ( string.lower( marker ), content ) )
-
+
def find_content( self, marker ):
for item in self.items:
if ( item[0] == marker ):
@@ -629,23 +616,24 @@ class DocBlock:
def dump_html( self ):
- types = [ 'type', 'struct', 'functype', 'function', 'constant',
- 'enum', 'macro' ]
+ types = [ 'type', 'struct', 'functype', 'function',
+ 'constant', 'enum', 'macro' ]
parameters = [ 'input', 'inout', 'output', 'return' ]
if not self.items:
return
- # place html anchor when needed
- if self.name:
- print '<a name="'+self.name+'">'
-
# start of a block
#
print block_header
- print "<h4>" + self.name + "</h4>"
+ # place html anchor if needed
+ #
+ if self.name:
+ print '<a name="' + self.name + '">'
+ print "<h4>" + self.name + "</h4>"
+ print "</a>"
# print source code
#
@@ -657,12 +645,13 @@ class DocBlock:
while l >= 0 and string.strip( lines[l] ) == "":
l = l - 1
print source_header
+ print ""
for line in lines[0 : l + 1]:
- print line
+ print line
print source_footer
in_table = 0
-
+
# dump each (marker,content) element
#
for element in self.items:
@@ -675,19 +664,19 @@ class DocBlock:
print description_footer
elif not ( marker in types ):
-
- print marker_header
- print marker
- print marker_inter
+ sys.stdout.write( marker_header )
+ sys.stdout.write( marker )
+ sys.stdout.write( marker_inter + '\n' )
content.dump_html()
print marker_footer
-
+
print ""
print block_footer
-######################################################################################
+
+#############################################################################
#
# The DocSection class is used to store a given documentation section.
#
@@ -725,7 +714,7 @@ class DocSection:
# section
#
if self.elements.has_key( block.name ):
- sys.stderr.write( "ERROR - duplicate element definition for " +
+ sys.stderr.write( "ERROR - duplicate element definition for " +
"'" + block.name + "' in section '" +
section.name + "'" )
sys.quit()
@@ -767,8 +756,8 @@ class DocSectionList:
self.sections = {}
self.list = []
self.current_section = None
- self.index = [] # sorted list of blocks that are not sections
-
+ self.index = [] # sorted list of blocks that
+ # are not sections
def append_section( self, block ):
name = string.lower( block.name )
@@ -776,7 +765,7 @@ class DocSectionList:
if self.sections.has_key( name ):
# There is already a section with this name in our
- # list. We'll try to complete it.
+ # list. We will try to complete it.
#
section = self.sections[name]
if section.abstract:
@@ -789,7 +778,7 @@ class DocSectionList:
" for '" + name + "'" )
sys.quit()
else:
- # The old section didn't contain an abstract; we're
+ # The old section didn't contain an abstract; we are
# now going to replace it.
#
section.abstract = abstract
@@ -802,7 +791,7 @@ class DocSectionList:
section = DocSection( block )
self.sections[name] = section
self.list.append( section )
-
+
self.current_section = section
@@ -822,12 +811,14 @@ class DocSectionList:
def prepare_files( self, file_prefix = None ):
# prepare the section list, by computing section filenames
# and the index
+ #
if file_prefix:
prefix = file_prefix + "-"
else:
prefix = ""
# compute section names
+ #
for section in self.sections.values():
title_content = section.block.find_content( "title" )
if title_content:
@@ -835,7 +826,8 @@ class DocSectionList:
else:
section.title = "UNKNOWN_SECTION_TITLE!"
- # compute section filenames
+ # compute section filenames
+ #
for section in self.sections.values():
section.filename = prefix + section.name + ".html"
@@ -843,8 +835,9 @@ class DocSectionList:
self.index_filename = prefix + "index.html"
# compute the sorted block list for the index
+ #
self.index.sort( block_lexicographical_compare )
-
+
def dump_html_toc( self ):
# dump an html table of contents
@@ -852,7 +845,7 @@ class DocSectionList:
old_stdout = sys.stdout
new_file = open( self.toc_filename, "w" )
sys.stdout = new_file
-
+
print html_header
print "<center><h1>Table of Contents</h1></center>"
@@ -861,9 +854,9 @@ class DocSectionList:
for section in self.list:
if section.abstract:
print "<tr valign=top><td>"
- print '<a href="' + section.filename + '">'
- print section.title
- print "</a></td><td>"
+ sys.stdout.write( '<a href="' + section.filename + '">' )
+ sys.stdout.write( section.title )
+ sys.stdout.write( "</a></td><td>" + '\n' )
section.abstract.dump_html()
print "</td></tr>"
@@ -878,7 +871,6 @@ class DocSectionList:
old_stdout = sys.stdout
for section in self.sections.values():
-
if section.filename:
new_file = open( section.filename, "w" )
sys.stdout = new_file
@@ -889,7 +881,6 @@ class DocSectionList:
def dump_html_index( self ):
-
old_stdout = sys.stdout
new_file = open( self.index_filename, "w" )
sys.stdout = new_file
@@ -899,36 +890,32 @@ class DocSectionList:
line = 0
print html_header
-
print "<center><h1>General Index</h1></center>"
-
print "<center><table cellpadding=5><tr valign=top><td>"
for block in self.index:
+ sys.stdout.write( '<a href="' + block.section.filename +
+ '#' + block.name + '">' )
+ sys.stdout.write( block.name )
+ sys.stdout.write( "</a><br>" + '\n' )
- print '<a href="'+block.section.filename+'#'+block.name+'">'
- print block.name
- print "</a><br>"
-
- if line*num_columns >= total:
+ if line * num_columns >= total:
print "</td><td>"
line = 0
else:
- line = line+1
+ line = line + 1
print "</tr></table></center>"
-
print html_footer
-
+
sys.stdout = old_stdout
-
+
# Filter a given list of DocBlocks. Returns a new list
# of DocBlock objects that only contains element whose
# "type" (i.e. first marker) is in the "types" parameter.
#
def filter_blocks_by_type( block_list, types ):
-
new_list = []
for block in block_list:
if block.items:
@@ -964,7 +951,6 @@ def block_lexicographical_compare( b1, b2 ):
return 1
-
# dump a list block as a single HTML page
#
def dump_html_1( block_list ):
@@ -976,18 +962,16 @@ def dump_html_1( block_list ):
print html_footer
-
-
def make_block_list_inner():
"""parse a file and extract comments blocks from it"""
file_list = []
sys.stderr.write( repr( sys.argv[1:] ) + '\n' )
-
+
for pathname in sys.argv[1:]:
newpath = glob.glob( pathname )
- sys.stderr.write ( repr(newpath) + '\n' )
- last = len(file_list)
+ sys.stderr.write( repr(newpath) + '\n' )
+ last = len( file_list )
file_list[last:last] = newpath
if len( file_list ) == 0:
@@ -1006,9 +990,9 @@ def make_block_list_inner():
# 4 - wait for beginning of source (or comment ??)
# 5 - process source
#
- comment = []
- source = []
- state = 0
+ comment = []
+ source = []
+ state = 0
for line in fileinput.input( file_list ):
l = len( line )
@@ -1144,7 +1128,6 @@ def make_block_list_inner():
# create a list of DocBlock elements
#
def make_block_list():
-
source_block_list = make_block_list_inner()
list = []
@@ -1155,7 +1138,6 @@ def make_block_list():
return list
-
# This function is only used for debugging
#
def dump_block_list( list ):
@@ -1191,8 +1173,8 @@ def main( argv ):
section_list.dump_html_toc()
section_list.dump_html_sections()
section_list.dump_html_index()
-
- # list2 = filter_blocks( list, ['type','macro','enum','constant', 'functype'] )
+
+ # list2 = filter_blocks( list, ['type','macro','enum','constant','functype'] )
# list2 = list
# list2.sort( block_lexicographical_compare )
@@ -1203,6 +1185,7 @@ def main( argv ):
# If called from the command line
+#
if __name__ == '__main__':
main( sys.argv )
diff --git a/include/freetype/cache/ftcimage.h b/include/freetype/cache/ftcimage.h
index 7c10ef5..2746db5 100644
--- a/include/freetype/cache/ftcimage.h
+++ b/include/freetype/cache/ftcimage.h
@@ -35,9 +35,13 @@
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/*************************************************************************/
@@ -163,8 +167,10 @@ FT_BEGIN_HEADER
FT_UInt gindex,
FT_Glyph *aglyph );
+
/* */
+
FT_END_HEADER
#endif /* __FTCIMAGE_H__ */
diff --git a/include/freetype/cache/ftcmanag.h b/include/freetype/cache/ftcmanag.h
index 40d107b..a8b8a86 100644
--- a/include/freetype/cache/ftcmanag.h
+++ b/include/freetype/cache/ftcmanag.h
@@ -70,9 +70,14 @@
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /*************************************************************************/
+
#define FTC_MAX_FACES_DEFAULT 2
#define FTC_MAX_SIZES_DEFAULT 4
@@ -363,6 +368,7 @@ FT_BEGIN_HEADER
} FTC_CacheRec;
+
/* */
diff --git a/include/freetype/cache/ftcsbits.h b/include/freetype/cache/ftcsbits.h
index e86ea9d..a5555d9 100644
--- a/include/freetype/cache/ftcsbits.h
+++ b/include/freetype/cache/ftcsbits.h
@@ -26,63 +26,76 @@
#include FT_CACHE_IMAGE_H
-
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
-
- /***********************************************************************
- *
- * <Type> FTC_SBit
- *
- * <Description>
- * handle to a small bitmap descriptor. see the FTC_SBitRec
- * structure for details..
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /*************************************************************************/
+
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FTC_SBit */
+ /* */
+ /* <Description> */
+ /* A handle to a small bitmap descriptor. See the FTC_SBitRec */
+ /* structure for details. */
+ /* */
typedef struct FTC_SBitRec_* FTC_SBit;
- /***********************************************************************
- *
- * <Type> FTC_SBit_Cache
- *
- * <Description>
- * handle to a small bitmap cache. These are special cache objects
- * used to store small glyph bitmaps (and anti-aliased pixmaps) in
- * a much more efficient way than the traditional glyph image cache
- * implemented by FTC_Image_Cache
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FTC_SBit_Cache */
+ /* */
+ /* <Description> */
+ /* A handle to a small bitmap cache. These are special cache objects */
+ /* used to store small glyph bitmaps (and anti-aliased pixmaps) in a */
+ /* much more efficient way than the traditional glyph image cache */
+ /* implemented by FTC_Image_Cache. */
+ /* */
typedef struct FTC_SBit_CacheRec_* FTC_SBit_Cache;
- /***********************************************************************
- *
- * <Struct> FTC_SBitRec
- *
- * <Description>
- * a very compact structure used to describe a small glyph bitmap
- *
- * <Fields>
- * width :: bitmap width in pixels
- * height :: bitmap height in pixels
- *
- * left :: horizontal distance from pen position to left bitmap
- * border (a.k.a. "left side bearing", or "lsb")
- *
- * top :: vertical distance from pen position (on the baseline)
- * to the upper bitmap border (a.k.a. "top side bearing")
- * the distance is positive for upwards Y coordinates.
- *
- * format :: format of glyph bitmap (mono or gray)
- *
- * pitch :: number of bytes per bitmap lines. may be positive or
- * negative
- *
- * xadvance :: horizontal advance width in pixels
- * yadvance :: vertical advance height in pixels
- *
- * buffer :: pointer to bitmap pixels
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Struct> */
+ /* FTC_SBitRec */
+ /* */
+ /* <Description> */
+ /* A very compact structure used to describe a small glyph bitmap. */
+ /* */
+ /* <Fields> */
+ /* width :: The bitmap width in pixels. */
+ /* */
+ /* height :: The bitmap height in pixels. */
+ /* */
+ /* left :: The horizontal distance from the pen position to the */
+ /* left bitmap border (a.k.a. `left side bearing', or */
+ /* `lsb'). */
+ /* */
+ /* top :: The vertical distance from the pen position (on the */
+ /* baseline) to the upper bitmap border (a.k.a. `top side */
+ /* bearing'). The distance is positive for upwards */
+ /* Y coordinates. */
+ /* */
+ /* format :: The format of the glyph bitmap (monochrome or gray). */
+ /* */
+ /* pitch :: The number of bytes per bitmap line. May be positive */
+ /* or negative. */
+ /* */
+ /* xadvance :: The horizontal advance width in pixels. */
+ /* */
+ /* yadvance :: The vertical advance height in pixels. */
+ /* */
+ /* buffer :: A pointer to the bitmap pixels. */
+ /* */
typedef struct FTC_SBitRec_
{
FT_Byte width;
@@ -100,59 +113,64 @@ FT_BEGIN_HEADER
} FTC_SBitRec;
- /*************************************************************************
- *
- * <Section> FTC_SBit_Cache_New
- *
- * <Description>
- * Create a new cache to store small glyph bitmaps
- *
- * <Input>
- * manager :: handle to source cache manager
- *
- * <Output>
- * acache :: handle to new sbit cache. NULL in case of error
- *
- * <Return>
- * error code. 0 means success
- */
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FTC_SBit_Cache_New */
+ /* */
+ /* <Description> */
+ /* Creates a new cache to store small glyph bitmaps. */
+ /* */
+ /* <Input> */
+ /* manager :: A handle to the source cache manager. */
+ /* */
+ /* <Output> */
+ /* acache :: A handle to the new sbit cache. NULL in case of error. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
FT_EXPORT( FT_Error ) FTC_SBit_Cache_New( FTC_Manager manager,
FTC_SBit_Cache *acache );
- /*************************************************************************
- *
- * <Section> FTC_SBit_Cache_Lookup
- *
- * <Description>
- * Lookup a given small glyph bitmap in a given sbit cache
- *
- * <Input>
- * cache :: handle to source sbit cache
- * desc :: pointer to glyph image descriptor
- * gindex :: glyph index
- *
- * <Output>
- * sbit :: handle to a small bitmap descriptor
- *
- * <Return>
- * error code. 0 means success
- *
- * <Note>
- * the small bitmap descriptor, and its bit buffer are owned by the
- * cache and should never be freed by the application. They might
- * as well disappear from memory on the next cache lookup, so don't
- * treat them like persistent data..
- *
- * the descriptor's "buffer" field is set to 0 to indicate a missing
- * glyph bitmap.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FTC_SBit_Cache_Lookup */
+ /* */
+ /* <Description> */
+ /* Looks up a given small glyph bitmap in a given sbit cache. */
+ /* */
+ /* <Input> */
+ /* cache :: A handle to the source sbit cache. */
+ /* desc :: A pointer to the glyph image descriptor. */
+ /* gindex :: The glyph index. */
+ /* */
+ /* <Output> */
+ /* sbit :: A handle to a small bitmap descriptor. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
+ /* <Note> */
+ /* The small bitmap descriptor and its bit buffer are owned by the */
+ /* cache and should never be freed by the application. They might */
+ /* as well disappear from memory on the next cache lookup, so don't */
+ /* treat them as persistent data. */
+ /* */
+ /* The descriptor's `buffer' field is set to 0 to indicate a missing */
+ /* glyph bitmap. */
+ /* */
FT_EXPORT( FT_Error ) FTC_SBit_Cache_Lookup( FTC_SBit_Cache cache,
FTC_Image_Desc* desc,
FT_UInt gindex,
FTC_SBit *sbit );
+
/* */
+
FT_END_HEADER
#endif /* __FTCSBITS_H__ */
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 17ec707..6f98776 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -55,18 +55,23 @@ FT_BEGIN_HEADER
/*************************************************************************/
/*************************************************************************/
- /*************************************************************************
- *
- * <Section> base_interface
- *
- * <Title> Base Interface
- *
- * <Abstract>
- * The FreeType 2 base font interface
- *
- * <Description>
- * This sections details the public high-level API of FreeType 2
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* base_interface */
+ /* */
+ /* <Title> */
+ /* Base Interface */
+ /* */
+ /* <Abstract> */
+ /* The FreeType 2 base font interface. */
+ /* */
+ /* <Description> */
+ /* This section describes the public high-level API of FreeType 2. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -2243,6 +2248,7 @@ FT_BEGIN_HEADER
FT_EXPORT( void ) FT_Vector_Transform( FT_Vector* vec,
FT_Matrix* matrix );
+
/* */
diff --git a/include/freetype/ftbbox.h b/include/freetype/ftbbox.h
index 9d9252f..ddc506c 100644
--- a/include/freetype/ftbbox.h
+++ b/include/freetype/ftbbox.h
@@ -38,9 +38,13 @@
FT_BEGIN_HEADER
- /********************************
- * <Section> outline_processing
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* outline_processing */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h
index 81b8d49..cedf6d9 100644
--- a/include/freetype/ftcache.h
+++ b/include/freetype/ftcache.h
@@ -50,19 +50,24 @@ FT_BEGIN_HEADER
#define FT_CACHE_INTERNAL_GLYPH_H FT2_PUBLIC_FILE(cache/ftcglyph.h)
#define FT_CACHE_INTERNAL_CHUNK_H FT2_PUBLIC_FILE(cache/ftcchunk.h)
- /**************************************************************************
- *
- * <Section> cache_subsystem
- *
- * <Title> Cache Sub-System
- *
- * <Abstract>
- * How to cache face, size and glyph data with FreeType 2
- *
- * <Description>
- * This section details the FreeType 2 cache sub-system which is still
- * in beta.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* cache_subsystem */
+ /* */
+ /* <Title> */
+ /* Cache Sub-System */
+ /* */
+ /* <Abstract> */
+ /* How to cache face, size, and glyph data with FreeType 2. */
+ /* */
+ /* <Description> */
+ /* This section describes the FreeType 2 cache sub-system which is */
+ /* stile in beta. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/*************************************************************************/
@@ -345,6 +350,9 @@ FT_BEGIN_HEADER
FTC_Cache *acache );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTCACHE_H__ */
diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index 7824b81..60dcf35 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -39,20 +39,25 @@
FT_BEGIN_HEADER
+
/*************************************************************************/
/* */
- /* <Section> glyph_management */
+ /* <Section> */
+ /* glyph_management */
/* */
- /* <Title> Glyph Management */
+ /* <Title> */
+ /* Glyph Management */
/* */
/* <Abstract> */
- /* Generic interface to manage individual glyph data */
+ /* Generic interface to manage individual glyph data. */
/* */
/* <Description> */
/* This section contains definitions used to manage glyph data */
- /* through generic FT_Glyph objects. Each one of them can contain */
- /* a bitmap, a vector outline, or even images in other formats. */
+ /* through generic FT_Glyph objects. Each of them can contain a */
+ /* bitmap, a vector outline, or even images in other formats. */
/* */
+ /*************************************************************************/
+
/* forward declaration to a private type */
typedef struct FT_Glyph_Class_ FT_Glyph_Class;
@@ -296,7 +301,6 @@ FT_BEGIN_HEADER
/* */
/* The default value for `bbox_mode' is `ft_glyph_bbox_pixels'. */
/* */
-
enum
{
ft_glyph_bbox_unscaled = 0, /* return unscaled font units */
@@ -405,9 +409,13 @@ FT_BEGIN_HEADER
/* other helpful functions */
- /*****
- * <Section> base_interface
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* base_interface */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -448,6 +456,9 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Error ) FT_Matrix_Invert( FT_Matrix* matrix );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTGLYPH_H__ */
diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h
index 19e2b9b..8db5339 100644
--- a/include/freetype/ftimage.h
+++ b/include/freetype/ftimage.h
@@ -33,11 +33,14 @@
FT_BEGIN_HEADER
- /***********************************************************************
- *
- * <Section> basic_types
- *
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* basic_types */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -231,11 +234,13 @@ FT_BEGIN_HEADER
} FT_Bitmap;
- /***********************************************************************
- *
- * <Section> outline_processing
- *
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* outline_processing */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -528,11 +533,13 @@ FT_BEGIN_HEADER
} FT_Outline_Funcs;
- /***********************************************************************
- *
- * <Section> Basic_Types
- *
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* basic_types */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -612,18 +619,23 @@ FT_BEGIN_HEADER
/* */
/*************************************************************************/
- /************************************************************************
- *
- * <Section> Raster
- *
- * <Title> Scanline converter
- *
- * <Abstract>
- * How vectorial outlines are converted into bitmaps and pixmaps
- *
- * <Description>
- * This section contains technical definitions
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* Raster */
+ /* */
+ /* <Title> */
+ /* Scanline converter */
+ /* */
+ /* <Abstract> */
+ /* How vectorial outlines are converted into bitmaps and pixmaps. */
+ /* */
+ /* <Description> */
+ /* This section contains technical definitions. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -692,9 +704,9 @@ FT_BEGIN_HEADER
/* */
typedef struct FT_Span_
{
- short x;
- unsigned short len;
- unsigned char coverage;
+ short x;
+ unsigned short len;
+ unsigned char coverage;
} FT_Span;
@@ -804,28 +816,33 @@ FT_BEGIN_HEADER
/* <Fields> */
/* ft_raster_flag_default :: This value is 0. */
/* */
- /* ft_raster_flag_aa :: */
- /* this flag is set to indicate that a anti-aliased glyph image */
- /* should be generated. Otherwise, it will be monochrome (1-bit) */
- /* */
- /* ft_raster_flag_direct :: */
- /* this flag is set to indicate direct rendering. In this mode, */
- /* client applications must provide their own span callback. */
- /* this let them direct drawing or composition over an existing */
- /* bitmap. If this bit is not set, the target pixmap's buffer */
- /* _must_ be zeroed before rendering. */
- /* */
- /* note that for now, direct rendering is only possible with */
- /* anti-aliased glyphs only.. */
- /* */
- /* ft_raster_flag_clip :: */
- /* this flag is only used in direct rendering mode. When set, */
- /* the output will be clipped to a box specified in the "clip_box" */
- /* field of the FT_Raster_Params structure. */
- /* */
- /* note that by default, the glyph bitmap is clipped to the */
- /* target pixmap, except in direct rendering mode where all */
- /* spans are generated if no clipping box is set. */
+ /* ft_raster_flag_aa :: This flag is set to indicate that an */
+ /* anti-aliased glyph image should be */
+ /* generated. Otherwise, it will be */
+ /* monochrome (1-bit) */
+ /* */
+ /* ft_raster_flag_direct :: This flag is set to indicate direct */
+ /* rendering. In this mode, client */
+ /* applications must provide their own span */
+ /* callback. This lets them directly */
+ /* draw or compose over an existing bitmap. */
+ /* If this bit is not set, the target */
+ /* pixmap's buffer _must_ be zeroed before */
+ /* rendering. */
+ /* */
+ /* Note that for now, direct rendering is */
+ /* only possible with anti-aliased glyphs. */
+ /* */
+ /* ft_raster_flag_clip :: This flag is only used in direct */
+ /* rendering mode. If set, the output will */
+ /* be clipped to a box specified in the */
+ /* "clip_box" field of the FT_Raster_Params */
+ /* structure. */
+ /* */
+ /* Note that by default, the glyph bitmap */
+ /* is clipped to the target pixmap, except */
+ /* in direct rendering mode where all spans */
+ /* are generated if no clipping box is set. */
/* */
typedef enum
{
@@ -1066,6 +1083,9 @@ FT_BEGIN_HEADER
} FT_Raster_Funcs;
+ /* */
+
+
FT_END_HEADER
#endif /* __FTIMAGE_H__ */
diff --git a/include/freetype/ftlist.h b/include/freetype/ftlist.h
index 4d4397c..d0b96df 100644
--- a/include/freetype/ftlist.h
+++ b/include/freetype/ftlist.h
@@ -34,20 +34,24 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> list_processing
- *
- * <Title> List Processing
- *
- * <Abstract>
- * simple management of lists
- *
- * <Description>
- * This section contains various definitions related to list processing
- * using doubly-linked nodes.
- *
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* list_processing */
+ /* */
+ /* <Title> */
+ /* List Processing */
+ /* */
+ /* <Abstract> */
+ /* Simple management of lists. */
+ /* */
+ /* <Description> */
+ /* This section contains various definitions related to list */
+ /* processing using doubly-linked nodes. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -227,7 +231,9 @@ FT_BEGIN_HEADER
FT_Memory memory,
void* user );
+
/* */
+
FT_END_HEADER
diff --git a/include/freetype/ftmac.h b/include/freetype/ftmac.h
index 99654c7..442a27c 100644
--- a/include/freetype/ftmac.h
+++ b/include/freetype/ftmac.h
@@ -34,19 +34,24 @@
FT_BEGIN_HEADER
- /*******************************************************************
- *
- * <Section> Mac_Specific
- *
- * <Title> Mac-Specific Interface
- *
- * <Abstract>
- * Only available on the Macintosh
- *
- * <Description>
- * The following definitions are only available when FreeType
- * is compiled on a Macintosh.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* Mac_Specific */
+ /* */
+ /* <Title> */
+ /* Mac-Specific Interface */
+ /* */
+ /* <Abstract> */
+ /* Only available on the Macintosh. */
+ /* */
+ /* <Description> */
+ /* The following definitions are only available if FreeType is */
+ /* compiled on a Macintosh. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -78,7 +83,6 @@ FT_BEGIN_HEADER
/* { */
/* fond = GetResource( 'FOND', fontName ); */
/* error = FT_New_Face_From_FOND( library, fond, 0, &face ); */
- /* */
/* } */
/* */
FT_EXPORT( FT_Error ) FT_New_Face_From_FOND( FT_Library library,
@@ -86,8 +90,10 @@ FT_BEGIN_HEADER
FT_Long face_index,
FT_Face *aface );
+
/* */
+
FT_END_HEADER
diff --git a/include/freetype/ftmm.h b/include/freetype/ftmm.h
index bf4a1e6..33d1a0a 100644
--- a/include/freetype/ftmm.h
+++ b/include/freetype/ftmm.h
@@ -26,20 +26,25 @@
FT_BEGIN_HEADER
- /**********************************************************************
- *
- * <Section> Multiple_Masters
- *
- * <Title> Multiple Masters
- *
- * <Abstract>
- * How to manage multiple masters fonts
- *
- * <Description>
- * The following types and functions are used to manage multiple
- * master fonts, i.e. choose specific design instances by setting
- * design axis coordinates.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* multiple_masters */
+ /* */
+ /* <Title> */
+ /* Multiple Masters */
+ /* */
+ /* <Abstract> */
+ /* How to manage Multiple Masters fonts. */
+ /* */
+ /* <Description> */
+ /* The following types and functions are used to manage Multiple */
+ /* Master fonts, i.e. the selection of specific design instances by */
+ /* setting design axis coordinates. */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -182,6 +187,9 @@ FT_BEGIN_HEADER
FT_Fixed* coords );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTMM_H__ */
diff --git a/include/freetype/ftmodule.h b/include/freetype/ftmodule.h
index 0416c64..3fcc95e 100644
--- a/include/freetype/ftmodule.h
+++ b/include/freetype/ftmodule.h
@@ -26,18 +26,24 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> Module_Management
- *
- * <Title> Module Management
- *
- * <Abstract> How to add, upgrade and remove modules from FreeType
- *
- * <Description>
- * The definitions below are used to manage modules within FreeType.
- * Modules can be added, upgraded and removed at runtime.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* module_management */
+ /* */
+ /* <Title> */
+ /* Module Management */
+ /* */
+ /* <Abstract> */
+ /* How to add, upgrade, and remove modules from FreeType. */
+ /* */
+ /* <Description> */
+ /* The definitions below are used to manage modules within FreeType. */
+ /* Modules can be added, upgraded, and removed at runtime. */
+ /* */
+ /*************************************************************************/
+
/* module bit flags */
typedef enum FT_Module_Flags_
@@ -278,6 +284,9 @@ FT_BEGIN_HEADER
FT_EXPORT( void ) FT_Add_Default_Modules( FT_Library library );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTMODULE_H__ */
diff --git a/include/freetype/ftnames.h b/include/freetype/ftnames.h
index a824065..61ffd85 100644
--- a/include/freetype/ftnames.h
+++ b/include/freetype/ftnames.h
@@ -30,24 +30,29 @@
FT_BEGIN_HEADER
- /**************************************************************************
- *
- * <Section> SFNT_Names
- *
- * <Title> SFNT Names
- *
- * <Abstract> Access the names embedded in TrueType and OpenType files
- *
- * <Description>
- * The TrueType and OpenType specification allow the inclusion of
- * a special "names table" in font files. This table contains textual
- * (and internationalised) information regarding the font, like
- * family name, copyright, version, etc..
- *
- * the definitions below are used to access them when available
- *
- * note that this has nothing to do with "glyph names" !!
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* sfnt_names */
+ /* */
+ /* <Title> */
+ /* SFNT Names */
+ /* */
+ /* <Abstract> */
+ /* Access the names embedded in TrueType and OpenType files. */
+ /* */
+ /* <Description> */
+ /* The TrueType and OpenType specification allow the inclusion of */
+ /* a special `names table' in font files. This table contains */
+ /* textual (and internationalized) information regarding the font, */
+ /* like family name, copyright, version, etc. */
+ /* */
+ /* The definitions below are used to access them if available. */
+ /* */
+ /* Note that this has nothing to do with glyph names! */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -137,8 +142,11 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Error ) FT_Get_Sfnt_Name( FT_Face face,
FT_UInt index,
FT_SfntName *aname );
+
+
/* */
+
FT_END_HEADER
#endif /* __FTNAMES_H__ */
diff --git a/include/freetype/ftoutln.h b/include/freetype/ftoutln.h
index 9c16ca1..52b2d57 100644
--- a/include/freetype/ftoutln.h
+++ b/include/freetype/ftoutln.h
@@ -27,21 +27,25 @@
FT_BEGIN_HEADER
+
/*************************************************************************/
/* */
- /* <Section> outline_processing */
+ /* <Section> */
+ /* outline_processing */
/* */
- /* <Title> Outline Processing */
+ /* <Title> */
+ /* Outline Processing */
/* */
/* <Abstract> */
- /* Functions to create, transform and render vectorial glyph images */
+ /* Functions to create, transform, and render vectorial glyph images. */
/* */
/* <Description> */
- /* This sections contains routines used to create and destroy */
- /* scalable glyph images known as "outlines". These can also be */
- /* measured, transformed and converted into bitmaps, pixmaps and */
- /* */
+ /* This section contains routines used to create and destroy scalable */
+ /* glyph images known as `outlines'. These can also be measured, */
+ /* transformed, and converted into bitmaps and pixmaps. */
/* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -331,6 +335,9 @@ FT_BEGIN_HEADER
FT_Raster_Params* params );
+ /* */
+
+
FT_END_HEADER
#endif /* __FTOUTLN_H__ */
diff --git a/include/freetype/ftrender.h b/include/freetype/ftrender.h
index fa4d1f9..c6a0d2e 100644
--- a/include/freetype/ftrender.h
+++ b/include/freetype/ftrender.h
@@ -27,9 +27,14 @@
FT_BEGIN_HEADER
- /****
- * <Section> Module_Management
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* module_management */
+ /* */
+ /*************************************************************************/
+
/* create a new glyph object */
typedef FT_Error (*FT_Glyph_Init_Func) ( FT_Glyph glyph,
@@ -183,6 +188,7 @@ FT_BEGIN_HEADER
FT_UInt num_params,
FT_Parameter* parameters );
+
/* */
diff --git a/include/freetype/ftsystem.h b/include/freetype/ftsystem.h
index 802a61e..f355421 100644
--- a/include/freetype/ftsystem.h
+++ b/include/freetype/ftsystem.h
@@ -264,8 +264,10 @@ FT_BEGIN_HEADER
unsigned char* limit;
};
+
/* */
+
FT_END_HEADER
#endif /* __FTSYSTEM_H__ */
diff --git a/include/freetype/fttypes.h b/include/freetype/fttypes.h
index 4f03c8b..a31c00f 100644
--- a/include/freetype/fttypes.h
+++ b/include/freetype/fttypes.h
@@ -29,19 +29,24 @@
FT_BEGIN_HEADER
+
/*************************************************************************/
/* */
- /* <Section> basic_types */
+ /* <Section> */
+ /* basic_types */
/* */
- /* <Title> Basic Data Types */
+ /* <Title> */
+ /* Basic Data Types */
/* */
/* <Abstract> */
- /* The basic data types defined by the library */
+ /* The basic data types defined by the library. */
/* */
/* <Description> */
- /* This sections contains the basic data types defined by FreeType 2, */
- /* rangine from simple scalar types to font specific ones */
+ /* This section contains the basic data types defined by FreeType 2, */
+ /* ranging from simple scalar types to font specific ones. */
/* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -341,7 +346,6 @@ FT_BEGIN_HEADER
} FT_Generic;
-
/*************************************************************************/
/* */
/* <Macro> */
@@ -366,10 +370,14 @@ FT_BEGIN_HEADER
/*************************************************************************/
/*************************************************************************/
- /**************************************************************************
- *
- * <Section> list_processing
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* list_processing */
+ /* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -440,6 +448,7 @@ FT_BEGIN_HEADER
} FT_ListRec;
+
/* */
#define FT_IS_EMPTY( list ) ( (list).head == 0 )
diff --git a/include/freetype/t1tables.h b/include/freetype/t1tables.h
index 696c4cb..cc23dde 100644
--- a/include/freetype/t1tables.h
+++ b/include/freetype/t1tables.h
@@ -28,18 +28,24 @@
FT_BEGIN_HEADER
- /********************************************************************
- *
- * <Section> Type1_Tables
- *
- * <Title> Type 1 Tables
- *
- * <Abstract> Type 1 (Postscript) specific font tables
- *
- * <Description>
- * This section ....
- */
+ /*************************************************************************/
+ /* */
+ /* <Section> */
+ /* type1_tables */
+ /* */
+ /* <Title> */
+ /* Type 1 Tables */
+ /* */
+ /* <Abstract> */
+ /* Type 1 (PostScript) specific font tables. */
+ /* */
+ /* <Description> */
+ /* This section contains the definition of Type 1-specific tables, */
+ /* including structures related to other PostScript font formats. */
+ /* */
+ /*************************************************************************/
+
/* Note that we separate font data in T1_FontInfo and T1_Private */
/* structures in order to support Multiple Master fonts. */
@@ -246,6 +252,9 @@ FT_BEGIN_HEADER
} CID_Info;
+ /* */
+
+
FT_END_HEADER
#endif /* __T1TABLES_H__ */
diff --git a/include/freetype/tttables.h b/include/freetype/tttables.h
index 557fd2c..e2caaf8 100644
--- a/include/freetype/tttables.h
+++ b/include/freetype/tttables.h
@@ -29,17 +29,21 @@ FT_BEGIN_HEADER
/*************************************************************************/
/* */
- /* <Section> TrueType_Tables */
+ /* <Section> */
+ /* truetype_tables */
/* */
- /* <Title> TrueType Tables */
+ /* <Title> */
+ /* TrueType Tables */
/* */
/* <Abstract> */
- /* TrueType-specific table types and functions */
+ /* TrueType-specific table types and functions. */
/* */
/* <Description> */
- /* This sections contains the definition of TrueType-specific tables */
+ /* This section contains the definition of TrueType-specific tables */
/* as well as some routines used to access and process them. */
/* */
+ /*************************************************************************/
+
/*************************************************************************/
/* */
@@ -586,6 +590,7 @@ FT_BEGIN_HEADER
/* */
+
FT_END_HEADER
#endif /* __TTTABLES_H__ */