/usr/share/vala/vapi/valadoc-1.0.vapi is in libvaladoc-dev 0.23.2~git20150422-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* valadoc-1.0.vapi generated by valac 0.30.0, do not modify. */
namespace Valadoc {
namespace Api {
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Array : Valadoc.Api.Item {
public Array (Valadoc.Api.Item parent, void* data);
protected override Valadoc.Content.Inline build_signature ();
public Valadoc.Api.Item data_type { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Attribute : Valadoc.Api.Item {
public Attribute (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, void* data);
public Valadoc.Api.AttributeArgument add_boolean (string name, bool value, void* data = null);
public Valadoc.Api.AttributeArgument add_double (string name, double value, void* data = null);
public Valadoc.Api.AttributeArgument add_integer (string name, int value, void* data = null);
public Valadoc.Api.AttributeArgument add_string (string name, string value, void* data = null);
protected override Valadoc.Content.Inline build_signature ();
public Valadoc.Api.AttributeArgument? get_argument (string name);
public Valadoc.Api.SourceFile get_source_file ();
public string name { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class AttributeArgument : Valadoc.Api.Item {
public enum Type {
BOOLEAN,
INTEGER,
DOUBLE,
STRING
}
public AttributeArgument.boolean (Valadoc.Api.Attribute parent, Valadoc.Api.SourceFile file, global::string name, bool value, void* data);
protected override Valadoc.Content.Inline build_signature ();
public AttributeArgument.double (Valadoc.Api.Attribute parent, Valadoc.Api.SourceFile file, global::string name, global::double value, void* data);
public Valadoc.Api.SourceFile get_source_file ();
public bool get_value_as_boolean ();
public global::double get_value_as_double ();
public int get_value_as_integer ();
public global::string get_value_as_string ();
public AttributeArgument.integer (Valadoc.Api.Attribute parent, Valadoc.Api.SourceFile file, global::string name, int value, void* data);
public AttributeArgument.string (Valadoc.Api.Attribute parent, Valadoc.Api.SourceFile file, global::string name, global::string value, void* data);
public Valadoc.Api.AttributeArgument.Type argument_type { get; private set; }
public global::string name { get; private set; }
public global::string value { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ChildSymbolRegistrar : Valadoc.Api.Visitor {
public ChildSymbolRegistrar ();
public override void visit_class (Valadoc.Api.Class item);
public override void visit_interface (Valadoc.Api.Interface item);
public override void visit_namespace (Valadoc.Api.Namespace item);
public override void visit_package (Valadoc.Api.Package item);
public override void visit_property (Valadoc.Api.Property item);
public override void visit_struct (Valadoc.Api.Struct item);
public override void visit_tree (Valadoc.Api.Tree item);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Class : Valadoc.Api.TypeSymbol {
public Class (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? private_cname, string? class_macro_name, string? type_macro_name, string? is_type_macro_name, string? type_cast_macro_name, string? type_function_name, string? class_type_macro_name, string? is_class_type_macro_name, string? dbus_name, string? type_id, string? param_spec_function_name, string? ref_function_name, string? unref_function_name, string? free_function_name, string? finalize_function_name, string? take_value_function_cname, string? get_value_function_cname, string? set_value_function_cname, bool is_fundamental, bool is_abstract, bool is_basic_type, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
public void add_interface (Valadoc.Api.TypeReference iface);
protected override Valadoc.Content.Inline build_signature ();
public string get_class_macro_name ();
public string get_class_type_macro_name ();
public string? get_cname ();
public string? get_dbus_name ();
public string? get_finalize_function_name ();
public string? get_free_function_name ();
public Gee.Collection<Valadoc.Api.TypeReference> get_full_implemented_interface_list ();
public string? get_get_value_function_cname ();
public Gee.Collection<Valadoc.Api.TypeReference> get_implemented_interface_list ();
public string get_is_class_type_macro_name ();
public Gee.Collection<Valadoc.Api.Class> get_known_child_classes ();
public Gee.Collection<Valadoc.Api.Interface> get_known_derived_interfaces ();
public string? get_param_spec_function_cname ();
public string? get_private_cname ();
public string? get_ref_function_cname ();
public string? get_set_value_function_cname ();
public string? get_take_value_function_cname ();
public string? get_type_id ();
public string? get_unref_function_cname ();
public void register_child_class (Valadoc.Api.Class cl);
public void register_derived_interface (Valadoc.Api.Interface iface);
public Valadoc.Api.TypeReference? base_type { get; set; }
public bool is_abstract { get; private set; }
public bool is_compact { get; }
public bool is_fundamental { get; private set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Constant : Valadoc.Api.Member {
public Constant (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string get_cname ();
public Valadoc.Api.TypeReference constant_type { get; set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Delegate : Valadoc.Api.TypeSymbol, Valadoc.Api.Callable {
public Delegate (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, bool is_static, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public bool is_static { get; private set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Enum : Valadoc.Api.TypeSymbol {
public Enum (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? type_macro_name, string? type_function_name, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class EnumValue : Valadoc.Api.Symbol {
public EnumValue (Valadoc.Api.Enum parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SourceComment? comment, string? cname, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string get_cname ();
public Valadoc.Content.Run default_value { get; set; }
public bool has_default_value { get; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ErrorCode : Valadoc.Api.Symbol {
public ErrorCode (Valadoc.Api.ErrorDomain parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SourceComment? comment, string? cname, string? dbus_name, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string get_cname ();
public string get_dbus_name ();
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ErrorDomain : Valadoc.Api.TypeSymbol {
public ErrorDomain (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? quark_macro_name, string? quark_function_name, string? dbus_name, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public string? get_dbus_name ();
public string get_quark_function_name ();
public string get_quark_macro_name ();
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Field : Valadoc.Api.Member {
public Field (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, bool is_static, bool is_volatile, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public Valadoc.Api.TypeReference? field_type { get; set; }
public bool is_static { get; private set; }
public bool is_volatile { get; private set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class FormalParameter : Valadoc.Api.Symbol {
public FormalParameter (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string? name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.FormalParameterType type, bool ellipsis, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public Valadoc.Content.Run default_value { get; set; }
public bool ellipsis { get; private set; }
public bool has_default_value { get; }
public bool is_out { get; }
public bool is_ref { get; }
public override Valadoc.Api.NodeType node_type { get; }
public Valadoc.Api.TypeReference? parameter_type { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class GirSourceComment : Valadoc.Api.SourceComment {
public GirSourceComment (string content, Valadoc.Api.SourceFile file, int first_line, int first_column, int last_line, int last_column);
public void add_parameter_content (string param_name, Valadoc.Api.SourceComment comment);
public Valadoc.Api.SourceComment? get_parameter_comment (string param_name);
public Gee.MapIterator<string,Valadoc.Api.SourceComment> parameter_iterator ();
public Valadoc.Api.SourceComment? deprecated_comment { get; set; }
public string? instance_param_name { get; set; }
public Valadoc.Api.SourceComment? return_comment { get; set; }
public Valadoc.Api.SourceComment? stability_comment { get; set; }
public Valadoc.Api.SourceComment? version_comment { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Interface : Valadoc.Api.TypeSymbol {
public Interface (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? type_macro_name, string? is_type_macro_name, string? type_cast_macro_name, string? type_function_name, string interface_macro_name, string? dbus_name, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
public void add_interface (Valadoc.Api.TypeReference iface);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public string? get_dbus_name ();
public Gee.Collection<Valadoc.Api.TypeReference> get_full_implemented_interface_list ();
public Gee.Collection<Valadoc.Api.TypeReference> get_implemented_interface_list ();
public string get_interface_macro_name ();
public Gee.Collection<Valadoc.Api.Class> get_known_implementations ();
public Gee.Collection<Valadoc.Api.Interface> get_known_related_interfaces ();
public void register_implementation (Valadoc.Api.Class cl);
public void register_related_interface (Valadoc.Api.Interface iface);
public Valadoc.Api.TypeReference? base_type { get; set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Item : GLib.Object {
public Item (void* data);
protected abstract Valadoc.Content.Inline build_signature ();
public void* data { get; private set; }
public Valadoc.Api.Item parent { get; protected set; }
public Valadoc.Content.Inline signature { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Member : Valadoc.Api.Symbol {
public Member (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, void* data);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Method : Valadoc.Api.Member, Valadoc.Api.Callable {
public Method (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? dbus_name, string? dbus_result_name, string? finish_function_cname, Valadoc.MethodBindingType binding_type, bool is_yields, bool is_dbus_visible, bool is_constructor, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public string get_dbus_name ();
public string get_dbus_result_name ();
public string? get_finish_function_cname ();
public Valadoc.Api.Method? base_method { get; set; }
public bool is_abstract { get; }
public bool is_constructor { get; private set; }
public bool is_dbus_visible { get; private set; }
public bool is_inline { get; }
public bool is_override { get; }
public bool is_static { get; }
public bool is_virtual { get; }
public bool is_yields { get; private set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Namespace : Valadoc.Api.Symbol {
public Namespace (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string? name, Valadoc.Api.SourceComment? comment, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Node : Valadoc.Api.Item, Valadoc.Api.Browsable, Valadoc.Documentation, Gee.Comparable<Valadoc.Api.Node> {
protected bool do_document;
public Node (Valadoc.Api.Node? parent, Valadoc.Api.SourceFile? file, string? name, void* data);
public abstract void accept (Valadoc.Api.Visitor visitor);
public void accept_all_children (Valadoc.Api.Visitor visitor, bool filtered = true);
public void accept_children (Valadoc.Api.NodeType[] types, Valadoc.Api.Visitor visitor, bool filtered = true);
public void accept_children_by_type (Valadoc.Api.NodeType type, Valadoc.Api.Visitor visitor, bool filtered = true);
public void add_child (Valadoc.Api.Symbol child);
public Valadoc.Api.Node? find_by_name (string name);
public Gee.List<Valadoc.Api.Node> get_children_by_type (Valadoc.Api.NodeType type, bool filtered = true);
public Gee.List<Valadoc.Api.Node> get_children_by_types (Valadoc.Api.NodeType[] types, bool filtered = true);
public string? get_full_name ();
public Valadoc.Api.SourceFile get_source_file ();
public bool has_children (Valadoc.Api.NodeType[] types);
public bool has_children_by_type (Valadoc.Api.NodeType type);
public bool has_visible_children_by_type (Valadoc.Api.NodeType type, Valadoc.Settings settings);
public bool has_visible_children_by_types (Valadoc.Api.NodeType[] types, Valadoc.Settings settings);
public abstract bool is_browsable (Valadoc.Settings settings);
public Valadoc.Content.Comment? documentation { get; internal set; }
public string? name { get; private set; }
public abstract Valadoc.Api.NodeType node_type { get; }
public Valadoc.Api.Namespace? nspace { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Package : Valadoc.Api.Node {
public Package (string name, bool is_package, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public Gee.Collection<Valadoc.Api.Package> get_dependency_list ();
public Gee.Map<string?,Gee.Collection<Valadoc.Api.Symbol>> get_deprecated_symbols ();
public Gee.Collection<Valadoc.Api.Package> get_full_dependency_list ();
public override bool is_browsable (Valadoc.Settings settings);
public bool is_package { get; private set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Pointer : Valadoc.Api.Item {
public Pointer (Valadoc.Api.Item parent, void* data);
protected override Valadoc.Content.Inline build_signature ();
public Valadoc.Api.Item data_type { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Property : Valadoc.Api.Member {
public Property (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? dbus_name, bool is_dbus_visible, Valadoc.Api.PropertyBindingType binding_type, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public string get_dbus_name ();
public Valadoc.Api.Property base_property { get; set; }
public Valadoc.Api.PropertyAccessor? getter { get; internal set; }
public bool is_abstract { get; }
public bool is_dbus_visible { get; private set; }
public bool is_override { get; }
public bool is_virtual { get; }
public override Valadoc.Api.NodeType node_type { get; }
public Valadoc.Api.TypeReference? property_type { get; set; }
public Valadoc.Api.PropertyAccessor? setter { get; internal set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class PropertyAccessor : Valadoc.Api.Symbol {
public PropertyAccessor (Valadoc.Api.Property parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, string? cname, Valadoc.Api.PropertyAccessorType type, Valadoc.Api.Ownership ownership, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public bool is_construct { get; }
public bool is_get { get; }
public bool is_owned { get; }
public bool is_set { get; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Signal : Valadoc.Api.Member, Valadoc.Api.Callable {
public Signal (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? default_impl_cname, string? dbus_name, bool is_dbus_visible, bool is_virtual, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public string get_dbus_name ();
public string? get_default_impl_cname ();
public bool is_dbus_visible { get; private set; }
public bool is_virtual { get; private set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SignatureBuilder {
public SignatureBuilder ();
public Valadoc.Api.SignatureBuilder append (string text, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_attribute (string text, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_content (Valadoc.Content.Inline content, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_highlighted (string text, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_keyword (string keyword, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_literal (string literal, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_symbol (Valadoc.Api.Node node, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_type (Valadoc.Api.Node node, bool spaced = true);
public Valadoc.Api.SignatureBuilder append_type_name (string name, bool spaced = true);
public new Valadoc.Content.Run @get ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SourceComment {
public SourceComment (string content, Valadoc.Api.SourceFile file, int first_line, int first_column, int last_line, int last_column);
public string content { get; private set; }
public Valadoc.Api.SourceFile file { get; private set; }
public int first_column { get; private set; }
public int first_line { get; private set; }
public int last_column { get; private set; }
public int last_line { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SourceFile : GLib.Object {
public SourceFile (Valadoc.Api.Package package, string relative_path, string? relative_c_path, void* data);
public string get_name ();
public void* data { get; private set; }
public Valadoc.Api.Package package { get; private set; }
public string? relative_c_path { get; private set; }
public string relative_path { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Struct : Valadoc.Api.TypeSymbol {
public Struct (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? cname, string? type_macro_name, string? type_function_name, string? type_id, string? dup_function_cname, string? copy_function_cname, string? destroy_function_cname, string? free_function_cname, bool is_basic_type, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public string? get_cname ();
public string? get_copy_function_cname ();
public string? get_destroy_function_cname ();
public string? get_dup_function_cname ();
public string? get_free_function_cname ();
public Gee.Collection<Valadoc.Api.Struct> get_known_child_structs ();
public string? get_type_id ();
public void register_child_struct (Valadoc.Api.Struct stru);
public Valadoc.Api.TypeReference? base_type { get; set; }
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Symbol : Valadoc.Api.Node {
public Symbol (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string? name, Valadoc.Api.SymbolAccessibility accessibility, void* data);
public void add_attribute (Valadoc.Api.Attribute att);
public Valadoc.Api.Attribute? get_attribute (string name);
public Gee.Collection<Valadoc.Api.Attribute> get_attributes ();
public override bool is_browsable (Valadoc.Settings settings);
public Valadoc.Api.SymbolAccessibility accessibility { get; private set; }
public bool is_deprecated { get; private set; }
public bool is_internal { get; }
public bool is_private { get; }
public bool is_protected { get; }
public bool is_public { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Tree {
public Tree (Valadoc.ErrorReporter reporter, Valadoc.Settings settings, void* data = null);
public void accept (Valadoc.Api.Visitor visitor);
public void accept_children (Valadoc.Api.Visitor visitor);
public void add_external_c_files (string name);
public void add_package (Valadoc.Api.Package package);
public void check_comments (Valadoc.DocumentationParser docparser);
public bool create_tree ();
public Gee.Collection<string> get_external_c_files ();
public Gee.Collection<Valadoc.Api.Package> get_package_list ();
public void import_comments (Valadoc.Importer.DocumentationImporter[] importers, string[] packages, string[] import_directories);
public void parse_comments (Valadoc.DocumentationParser docparser);
public Valadoc.Api.Node? search_symbol_cstr (Valadoc.Api.Node? element, string cname);
public Valadoc.Api.Node? search_symbol_path (Valadoc.Api.Node? element, string[] path);
public Valadoc.Api.Node? search_symbol_str (Valadoc.Api.Node? element, string symname);
public Valadoc.Api.TypeSymbol? search_symbol_type_cstr (string cname);
public void* data { get; set; }
public Valadoc.WikiPageTree? wikitree { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class TypeParameter : Valadoc.Api.Symbol {
public TypeParameter (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, void* data);
public override void accept (Valadoc.Api.Visitor visitor);
protected override Valadoc.Content.Inline build_signature ();
public override bool is_browsable (Valadoc.Settings settings);
public override Valadoc.Api.NodeType node_type { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class TypeReference : Valadoc.Api.Item {
public TypeReference (Valadoc.Api.Item parent, Valadoc.Api.Ownership ownership, bool pass_ownership, bool is_dynamic, bool is_nullable, string? dbus_type_signature, void* data);
public void add_type_argument (Valadoc.Api.TypeReference type_ref);
protected override Valadoc.Content.Inline build_signature ();
public string? get_dbus_type_signature ();
public Gee.Collection<Valadoc.Api.TypeReference> get_type_arguments ();
public Valadoc.Api.Item? data_type { get; set; }
public bool is_dynamic { get; private set; }
public bool is_nullable { get; private set; }
public bool is_owned { get; }
public bool is_unowned { get; }
public bool is_weak { get; }
public bool pass_ownership { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class TypeSymbol : Valadoc.Api.Symbol {
public TypeSymbol (Valadoc.Api.Node parent, Valadoc.Api.SourceFile file, string name, Valadoc.Api.SymbolAccessibility accessibility, Valadoc.Api.SourceComment? comment, string? type_macro_name, string? is_type_macro_name, string? type_cast_macro_name, string? type_function_name, bool is_basic_type, void* data);
public string get_is_type_macro_name ();
public string get_type_cast_macro_name ();
public string get_type_function_name ();
public string get_type_macro_name ();
public bool is_basic_type { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Visitor : GLib.Object {
public Visitor ();
public virtual void visit_class (Valadoc.Api.Class item);
public virtual void visit_constant (Valadoc.Api.Constant item);
public virtual void visit_delegate (Valadoc.Api.Delegate item);
public virtual void visit_enum (Valadoc.Api.Enum item);
public virtual void visit_enum_value (Valadoc.Api.EnumValue item);
public virtual void visit_error_code (Valadoc.Api.ErrorCode item);
public virtual void visit_error_domain (Valadoc.Api.ErrorDomain item);
public virtual void visit_field (Valadoc.Api.Field item);
public virtual void visit_formal_parameter (Valadoc.Api.FormalParameter item);
public virtual void visit_interface (Valadoc.Api.Interface item);
public virtual void visit_method (Valadoc.Api.Method item);
public virtual void visit_namespace (Valadoc.Api.Namespace item);
public virtual void visit_package (Valadoc.Api.Package item);
public virtual void visit_property (Valadoc.Api.Property item);
public virtual void visit_signal (Valadoc.Api.Signal item);
public virtual void visit_struct (Valadoc.Api.Struct item);
public virtual void visit_tree (Valadoc.Api.Tree item);
public virtual void visit_type_parameter (Valadoc.Api.TypeParameter item);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Browsable : Valadoc.Api.Item {
public abstract bool is_browsable (Valadoc.Settings settings);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Callable : Valadoc.Api.Symbol {
public abstract Valadoc.Api.TypeReference? return_type { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum FormalParameterType {
IN,
OUT,
REF;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum NodeType {
CLASS,
CONSTANT,
CREATION_METHOD,
DELEGATE,
ENUM,
ENUM_VALUE,
ERROR_CODE,
ERROR_DOMAIN,
FIELD,
FORMAL_PARAMETER,
INTERFACE,
METHOD,
NAMESPACE,
PACKAGE,
PROPERTY,
PROPERTY_ACCESSOR,
SIGNAL,
STATIC_METHOD,
STRUCT,
TYPE_PARAMETER;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum Ownership {
DEFAULT,
UNOWNED,
OWNED,
WEAK;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum PropertyAccessorType {
CONSTRUCT,
SET,
GET;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum PropertyBindingType {
UNMODIFIED,
OVERRIDE,
ABSTRACT,
VIRTUAL;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum SymbolAccessibility {
PROTECTED,
INTERNAL,
PRIVATE,
PUBLIC;
public string to_string ();
}
}
namespace Charts {
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Chart : Valadoc.Api.Visitor {
protected Gvc.Context context;
protected Valadoc.Charts.Factory factory;
protected Gvc.Graph graph;
public Chart (Valadoc.Charts.Factory factory, Valadoc.Api.Node node);
public void save (string file_name, string file_type = "png");
public void write (GLib.FileStream file, string file_type);
public uint8[] write_buffer (string file_type);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Factory : GLib.Object {
public Factory ();
public abstract Gvc.Edge add_children (Gvc.Graph graph, Gvc.Node parent, Gvc.Node child);
public abstract Gvc.Node create_class (Gvc.Graph graph, Valadoc.Api.Class item);
public abstract Gvc.Context create_context (Gvc.Graph graph);
public abstract Gvc.Node create_delegate (Gvc.Graph graph, Valadoc.Api.Delegate item);
public abstract Gvc.Node create_enum (Gvc.Graph graph, Valadoc.Api.Enum item);
public abstract Gvc.Node create_errordomain (Gvc.Graph graph, Valadoc.Api.ErrorDomain item);
public abstract Gvc.Graph create_graph (Valadoc.Api.Node item);
public abstract Gvc.Node create_interface (Gvc.Graph graph, Valadoc.Api.Interface item);
public abstract Gvc.Node create_namespace (Gvc.Graph graph, Valadoc.Api.Namespace item);
public abstract Gvc.Node create_struct (Gvc.Graph graph, Valadoc.Api.Struct item);
protected Gvc.Node create_type (Gvc.Graph graph, Valadoc.Api.Node item);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Hierarchy : Valadoc.Charts.Chart {
public Hierarchy (Valadoc.Charts.Factory factory, Valadoc.Api.Node node);
public override void visit_class (Valadoc.Api.Class item);
public override void visit_interface (Valadoc.Api.Interface item);
public override void visit_struct (Valadoc.Api.Struct item);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SimpleFactory : Valadoc.Charts.Factory {
public SimpleFactory ();
public override Gvc.Edge add_children (Gvc.Graph graph, Gvc.Node parent, Gvc.Node child);
protected virtual Gvc.Node configure_type (Gvc.Node node, Valadoc.Api.Node item);
public override Gvc.Node create_class (Gvc.Graph graph, Valadoc.Api.Class item);
public override Gvc.Context create_context (Gvc.Graph graph);
public override Gvc.Node create_delegate (Gvc.Graph graph, Valadoc.Api.Delegate item);
public override Gvc.Node create_enum (Gvc.Graph graph, Valadoc.Api.Enum item);
public override Gvc.Node create_errordomain (Gvc.Graph graph, Valadoc.Api.ErrorDomain item);
public override Gvc.Graph create_graph (Valadoc.Api.Node item);
public override Gvc.Node create_interface (Gvc.Graph graph, Valadoc.Api.Interface item);
public override Gvc.Node create_namespace (Gvc.Graph graph, Valadoc.Api.Namespace item);
public override Gvc.Node create_struct (Gvc.Graph graph, Valadoc.Api.Struct item);
}
}
namespace Content {
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class BlockContent : Valadoc.Content.ContentElement {
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public override bool is_empty ();
public Gee.List<Valadoc.Content.Block> content { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Comment : Valadoc.Content.BlockContent {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public Gee.List<Valadoc.Content.Taglet> find_taglets (Valadoc.Api.Node? container, GLib.Type taglet_type);
public Gee.List<Valadoc.Content.Taglet> taglets { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class ContentElement : GLib.Object {
public ContentElement ();
public abstract void accept (Valadoc.Content.ContentVisitor visitor);
public virtual void accept_children (Valadoc.Content.ContentVisitor visitor);
public abstract void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public virtual void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public abstract Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public abstract bool is_empty ();
public Valadoc.Content.ContentElement parent { get; internal set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ContentFactory : GLib.Object {
public ContentFactory (Valadoc.Settings settings, Valadoc.ResourceLocator locator, Valadoc.ModuleLoader modules);
public Valadoc.Content.Comment create_comment ();
public Valadoc.Content.Embedded create_embedded ();
public Valadoc.Content.Headline create_headline ();
public Valadoc.Content.Link create_link ();
public Valadoc.Content.List create_list ();
public Valadoc.Content.ListItem create_list_item ();
public Valadoc.Content.Note create_note ();
public Valadoc.Content.Page create_page ();
public Valadoc.Content.Paragraph create_paragraph ();
public Valadoc.Content.Run create_run (Valadoc.Content.Run.Style style);
public Valadoc.Content.SourceCode create_source_code ();
public Valadoc.Content.Table create_table ();
public Valadoc.Content.TableCell create_table_cell ();
public Valadoc.Content.TableRow create_table_row ();
public Valadoc.Content.Taglet? create_taglet (string name);
public Valadoc.Content.Text create_text (string? text = null);
public Valadoc.Content.Warning create_warning ();
public Valadoc.Content.WikiLink create_wiki_link ();
public Valadoc.Content.ContentElement set_style_attributes (Valadoc.Content.StyleAttributes element, Valadoc.Content.VerticalAlign? valign, Valadoc.Content.HorizontalAlign? halign, string? style);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class ContentRenderer : Valadoc.Content.ContentVisitor {
public ContentRenderer ();
public abstract void render (Valadoc.Content.ContentElement element);
public abstract void render_children (Valadoc.Content.ContentElement element);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class ContentVisitor : GLib.Object {
public ContentVisitor ();
public virtual void visit_comment (Valadoc.Content.Comment element);
public virtual void visit_embedded (Valadoc.Content.Embedded element);
public virtual void visit_headline (Valadoc.Content.Headline element);
public virtual void visit_link (Valadoc.Content.Link element);
public virtual void visit_list (Valadoc.Content.List element);
public virtual void visit_list_item (Valadoc.Content.ListItem element);
public virtual void visit_note (Valadoc.Content.Note element);
public virtual void visit_page (Valadoc.Content.Page element);
public virtual void visit_paragraph (Valadoc.Content.Paragraph element);
public virtual void visit_run (Valadoc.Content.Run element);
public virtual void visit_source_code (Valadoc.Content.SourceCode element);
public virtual void visit_symbol_link (Valadoc.Content.SymbolLink element);
public virtual void visit_table (Valadoc.Content.Table element);
public virtual void visit_table_cell (Valadoc.Content.TableCell element);
public virtual void visit_table_row (Valadoc.Content.TableRow element);
public virtual void visit_taglet (Valadoc.Content.Taglet element);
public virtual void visit_text (Valadoc.Content.Text element);
public virtual void visit_warning (Valadoc.Content.Warning element);
public virtual void visit_wiki_link (Valadoc.Content.WikiLink element);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Embedded : Valadoc.Content.ContentElement, Valadoc.Content.Inline, Valadoc.Content.StyleAttributes {
public Valadoc.Api.Package package;
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public string? caption { get; set; }
public string url { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Headline : Valadoc.Content.InlineContent, Valadoc.Content.Block {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public int level { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class InlineContent : Valadoc.Content.ContentElement {
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override bool is_empty ();
public Gee.List<Valadoc.Content.Inline> content { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class InlineTaglet : Valadoc.Content.ContentElement, Valadoc.Content.Taglet, Valadoc.Content.Inline {
protected Valadoc.ResourceLocator locator;
protected Valadoc.Settings settings;
public InlineTaglet ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public abstract Valadoc.Rule? get_parser_rule (Valadoc.Rule run_rule);
public override bool is_empty ();
public abstract Valadoc.Content.ContentElement produce_content ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Link : Valadoc.Content.InlineContent, Valadoc.Content.Inline {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public Valadoc.Importer.InternalIdRegistrar id_registrar { get; internal set; }
public string url { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class List : Valadoc.Content.ContentElement, Valadoc.Content.Block {
public enum Bullet {
NONE,
UNORDERED,
ORDERED,
ORDERED_NUMBER,
ORDERED_LOWER_CASE_ALPHA,
ORDERED_UPPER_CASE_ALPHA,
ORDERED_LOWER_CASE_ROMAN,
ORDERED_UPPER_CASE_ROMAN;
public static Valadoc.Content.List.Bullet? from_string (string? str);
public unowned string to_string ();
}
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public Valadoc.Content.List.Bullet bullet { get; set; }
public Gee.List<Valadoc.Content.ListItem> items { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ListItem : Valadoc.Content.BlockContent {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Note : Valadoc.Content.BlockContent, Valadoc.Content.Block {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Page : Valadoc.Content.BlockContent {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Paragraph : Valadoc.Content.InlineContent, Valadoc.Content.Block, Valadoc.Content.StyleAttributes {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Run : Valadoc.Content.InlineContent, Valadoc.Content.Inline {
public enum Style {
NONE,
BOLD,
ITALIC,
UNDERLINED,
MONOSPACED,
STROKE,
LANG_KEYWORD,
LANG_LITERAL,
LANG_BASIC_TYPE,
LANG_TYPE;
public static Valadoc.Content.Run.Style? from_string (string str);
public unowned string to_string ();
}
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public Valadoc.Content.Run.Style style { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SourceCode : Valadoc.Content.ContentElement, Valadoc.Content.Inline {
public enum Language {
GENIE,
VALA,
C;
public static Valadoc.Content.SourceCode.Language? from_path (string path);
public static Valadoc.Content.SourceCode.Language? from_string (string str, bool is_extension = false);
public unowned string to_string ();
}
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public string code { get; set; }
public Valadoc.Content.SourceCode.Language? language { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SymbolLink : Valadoc.Content.InlineContent, Valadoc.Content.Inline {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override void configure (Valadoc.Settings settings, Valadoc.ResourceLocator locator);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public string given_symbol_name { get; set; }
public Valadoc.Api.Node symbol { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Table : Valadoc.Content.ContentElement, Valadoc.Content.Block {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public Gee.List<Valadoc.Content.TableRow> rows { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class TableCell : Valadoc.Content.InlineContent, Valadoc.Content.StyleAttributes {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public int colspan { get; set; }
public int rowspan { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class TableRow : Valadoc.Content.ContentElement {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void accept_children (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public Gee.List<Valadoc.Content.TableCell> cells { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Text : Valadoc.Content.ContentElement, Valadoc.Content.Inline {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public string content { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Warning : Valadoc.Content.BlockContent, Valadoc.Content.Block {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class WikiLink : Valadoc.Content.InlineContent, Valadoc.Content.Inline {
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public string name { get; set; }
public Valadoc.WikiPage page { get; internal set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Block : Valadoc.Content.ContentElement {
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Inline : Valadoc.Content.ContentElement {
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface StyleAttributes : Valadoc.Content.ContentElement {
public abstract Valadoc.Content.HorizontalAlign? horizontal_align { get; set; }
public abstract string? style { get; set; }
public abstract Valadoc.Content.VerticalAlign? vertical_align { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Taglet : Valadoc.Content.ContentElement {
public virtual Gee.List<Valadoc.Content.Inline>? get_inheritable_documentation ();
public abstract Valadoc.Rule? get_parser_rule (Valadoc.Rule run_rule);
public virtual bool inheritable (Valadoc.Content.Taglet taglet);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum HorizontalAlign {
LEFT,
RIGHT,
CENTER;
public static Valadoc.Content.HorizontalAlign? from_string (string str);
public unowned string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum VerticalAlign {
TOP,
MIDDLE,
BOTTOM;
public static Valadoc.Content.VerticalAlign? from_string (string str);
public unowned string to_string ();
}
}
namespace Devhelp {
[CCode (cheader_filename = "valadoc-1.0.h")]
public class MarkupWriter : Valadoc.MarkupWriter {
public MarkupWriter (GLib.FileStream stream, bool xml_declaration = true);
protected override bool content_inline_element (string name);
public Valadoc.Devhelp.MarkupWriter end_book ();
public Valadoc.Devhelp.MarkupWriter end_chapters ();
public Valadoc.Devhelp.MarkupWriter end_functions ();
public Valadoc.Devhelp.MarkupWriter end_sub ();
protected override bool inline_element (string name);
public Valadoc.Devhelp.MarkupWriter keyword (string name, string type, string link);
public Valadoc.Devhelp.MarkupWriter start_book (string title, string lang, string link, string name, string version, string author);
public Valadoc.Devhelp.MarkupWriter start_chapters ();
public Valadoc.Devhelp.MarkupWriter start_functions ();
public Valadoc.Devhelp.MarkupWriter start_sub (string name, string link);
}
}
namespace Gtkdoc {
[CCode (cheader_filename = "valadoc-1.0.h")]
public class MarkdownParser : GLib.Object, Valadoc.ResourceLocator {
public MarkdownParser (Valadoc.Settings settings, Valadoc.ErrorReporter reporter, Valadoc.Api.Tree? tree, Valadoc.ModuleLoader _modules);
public void init_rules ();
public Valadoc.Content.Comment? parse (Valadoc.Api.Node element, Valadoc.Api.GirSourceComment gir_comment, Valadoc.GirMetaData metadata, Valadoc.Importer.InternalIdRegistrar id_registrar, string? this_name = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class MarkdownScanner : GLib.Object, Valadoc.Scanner {
public MarkdownScanner (Valadoc.Settings settings);
public int get_line_start_column ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Parser : GLib.Object, Valadoc.ResourceLocator {
public Parser (Valadoc.Settings settings, Valadoc.ErrorReporter reporter, Valadoc.Api.Tree tree, Valadoc.ModuleLoader modules);
public Valadoc.Content.Comment? parse (Valadoc.Api.Node element, Valadoc.Api.GirSourceComment gir_comment, Valadoc.GirMetaData gir_metadata, Valadoc.Importer.InternalIdRegistrar id_registrar);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Scanner {
public Scanner ();
public Valadoc.Gtkdoc.Token next ();
public void reset (string content);
public static string unescape (string txt);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Token {
public Gee.HashMap<string,string>? attributes;
public string content;
public int first_column;
public int last_column;
public int length;
public int line;
public weak string start;
public Valadoc.Gtkdoc.TokenType type;
public Token (Valadoc.Gtkdoc.TokenType type, string content, Gee.HashMap<string,string>? attributes, string start, int length, int line, int first_column, int last_column);
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum TokenType {
XML_OPEN,
XML_CLOSE,
XML_COMMENT,
GTKDOC_FUNCTION,
GTKDOC_CONST,
GTKDOC_TYPE,
GTKDOC_PARAM,
GTKDOC_SOURCE_OPEN,
GTKDOC_SOURCE_CLOSE,
GTKDOC_SIGNAL,
GTKDOC_PROPERTY,
GTKDOC_PARAGRAPH,
NEWLINE,
SPACE,
WORD,
EOF
}
}
namespace Html {
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class BasicDoclet : Valadoc.Api.Visitor, Valadoc.Doclet {
protected Valadoc.Html.HtmlRenderer _renderer;
protected Valadoc.Html.CssClassResolver cssresolver;
protected Valadoc.Charts.Factory image_factory;
protected string package_list_link;
protected Valadoc.ErrorReporter reporter;
protected Valadoc.Api.Tree tree;
protected Valadoc.Html.MarkupWriter writer;
public BasicDoclet ();
protected void fetch_subnamespace_names (Valadoc.Api.Node node, Gee.ArrayList<Valadoc.Api.Namespace> namespaces);
protected virtual string get_icon_directory ();
protected virtual string get_img_path (Valadoc.Api.Node element, string type);
protected virtual string get_img_path_html (Valadoc.Api.Node element, string type);
protected string? get_link (Valadoc.Api.Node to, Valadoc.Api.Node from);
protected bool is_internal_node (Valadoc.Api.Node node);
public virtual void process (Valadoc.Settings settings, Valadoc.Api.Tree tree, Valadoc.ErrorReporter reporter);
protected void write_child_dependencies (Valadoc.Api.Package package, Valadoc.Api.Node? parent);
protected void write_child_namespaces (Valadoc.Api.Node node, Valadoc.Api.Node? parent);
protected void write_children (Valadoc.Api.Node node, Valadoc.Api.NodeType type, string type_string, Valadoc.Api.Node? container);
protected void write_file_footer ();
protected void write_file_header (string css, string js, string? title);
protected void write_image_block (Valadoc.Api.Node element);
public void write_namespace_content (Valadoc.Api.Namespace node, Valadoc.Api.Node? parent);
protected void write_namespace_note (Valadoc.Api.Node element);
protected void write_navi_children (Valadoc.Api.Node node, Valadoc.Api.NodeType type, Valadoc.Api.Node? parent);
protected void write_navi_entry (Valadoc.Api.Node element, Valadoc.Api.Node? pos, string style, bool link, bool full_name = false);
protected void write_navi_entry_html_template (string style, string content, bool is_deprecated);
protected void write_navi_entry_html_template_with_link (string style, string link, string content, bool is_deprecated);
protected void write_navi_leaf_symbol (Valadoc.Api.Node node);
protected void write_navi_package (Valadoc.Api.Package package);
public void write_navi_packages (Valadoc.Api.Tree tree);
public void write_navi_packages_inline (Valadoc.Api.Tree tree);
protected void write_navi_symbol (Valadoc.Api.Node node);
protected void write_navi_symbol_inline (Valadoc.Api.Node node, Valadoc.Api.Node? parent);
protected void write_navi_top_entry (Valadoc.Api.Node element, Valadoc.Api.Node? parent);
protected void write_package_content (Valadoc.Api.Package node, Valadoc.Api.Node? parent);
public void write_package_index_content (Valadoc.Api.Tree tree);
protected void write_package_note (Valadoc.Api.Node element);
public void write_symbol_content (Valadoc.Api.Node node);
protected void write_top_element_template (string link);
protected void write_top_elements (Valadoc.Api.Node element, Valadoc.Api.Node? parent);
protected virtual void write_wiki_page (Valadoc.WikiPage page, string contentp, string css_path, string js_path, string pkg_name);
protected void write_wiki_pages (Valadoc.Api.Tree tree, string css_path_wiki, string js_path_wiki, string contentp);
public Valadoc.Html.LinkHelper linker { get; protected set; }
public Valadoc.Settings settings { get; protected set; }
public string wiki_index_name { get; protected set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class CssClassResolver : Valadoc.Api.Visitor {
public CssClassResolver ();
public string resolve (Valadoc.Api.Node node);
public override void visit_class (Valadoc.Api.Class item);
public override void visit_constant (Valadoc.Api.Constant item);
public override void visit_delegate (Valadoc.Api.Delegate item);
public override void visit_enum (Valadoc.Api.Enum item);
public override void visit_enum_value (Valadoc.Api.EnumValue item);
public override void visit_error_code (Valadoc.Api.ErrorCode item);
public override void visit_error_domain (Valadoc.Api.ErrorDomain item);
public override void visit_field (Valadoc.Api.Field item);
public override void visit_interface (Valadoc.Api.Interface item);
public override void visit_method (Valadoc.Api.Method item);
public override void visit_namespace (Valadoc.Api.Namespace item);
public override void visit_package (Valadoc.Api.Package item);
public override void visit_property (Valadoc.Api.Property item);
public override void visit_signal (Valadoc.Api.Signal item);
public override void visit_struct (Valadoc.Api.Struct item);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class HtmlRenderer : Valadoc.Content.ContentRenderer {
protected Valadoc.Documentation? _container;
protected Valadoc.Documentation? _owner;
protected Valadoc.Html.CssClassResolver cssresolver;
protected Valadoc.Html.LinkHelper linker;
protected Valadoc.Settings settings;
protected weak Valadoc.Html.MarkupWriter writer;
public HtmlRenderer (Valadoc.Settings settings, Valadoc.Html.LinkHelper linker, Valadoc.Html.CssClassResolver cssresolver);
public override void render (Valadoc.Content.ContentElement element);
public override void render_children (Valadoc.Content.ContentElement element);
public void set_container (Valadoc.Documentation? container);
public void set_owner (Valadoc.Documentation? owner);
public void set_writer (Valadoc.Html.MarkupWriter writer);
public override void visit_comment (Valadoc.Content.Comment element);
public override void visit_embedded (Valadoc.Content.Embedded element);
public override void visit_headline (Valadoc.Content.Headline element);
public override void visit_link (Valadoc.Content.Link element);
public override void visit_list (Valadoc.Content.List element);
public override void visit_list_item (Valadoc.Content.ListItem element);
public override void visit_note (Valadoc.Content.Note element);
public override void visit_page (Valadoc.Content.Page element);
public override void visit_paragraph (Valadoc.Content.Paragraph element);
public override void visit_run (Valadoc.Content.Run element);
public override void visit_source_code (Valadoc.Content.SourceCode element);
public override void visit_symbol_link (Valadoc.Content.SymbolLink element);
public override void visit_table (Valadoc.Content.Table element);
public override void visit_table_cell (Valadoc.Content.TableCell element);
public override void visit_table_row (Valadoc.Content.TableRow element);
public override void visit_taglet (Valadoc.Content.Taglet element);
public override void visit_text (Valadoc.Content.Text element);
public override void visit_warning (Valadoc.Content.Warning element);
public override void visit_wiki_link (Valadoc.Content.WikiLink element);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class LinkHelper : GLib.Object {
protected Valadoc.Settings _settings;
public LinkHelper ();
protected virtual string? from_node_to_node (Valadoc.Api.Node from, Valadoc.Api.Node to);
protected virtual string? from_node_to_package (Valadoc.Api.Node from, Valadoc.Api.Package to);
protected virtual string? from_node_to_wiki (Valadoc.Api.Node from, Valadoc.WikiPage to);
protected virtual string? from_package_to_node (Valadoc.Api.Package from, Valadoc.Api.Node to);
protected virtual string? from_package_to_package (Valadoc.Api.Package from, Valadoc.Api.Package to);
protected virtual string? from_package_to_wiki (Valadoc.Api.Package from, Valadoc.WikiPage to);
protected virtual string? from_wiki_to_node (Valadoc.WikiPage from, Valadoc.Api.Node to);
protected virtual string? from_wiki_to_package (Valadoc.WikiPage from, Valadoc.Api.Package to);
protected virtual string? from_wiki_to_wiki (Valadoc.WikiPage from, Valadoc.WikiPage to);
public virtual string? get_package_link (Valadoc.Api.Package package, Valadoc.Settings settings);
public string? get_relative_link (Valadoc.Documentation from, Valadoc.Documentation to, Valadoc.Settings settings);
protected string translate_wiki_name (Valadoc.WikiPage page);
public bool enable_browsable_check { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class MarkupWriter : Valadoc.MarkupWriter {
public MarkupWriter (GLib.FileStream stream, bool xml_declaration = true);
public Valadoc.Html.MarkupWriter add_usemap (Valadoc.Charts.Chart chart);
public MarkupWriter.builder (GLib.StringBuilder builder, bool xml_declaration = true);
protected override bool content_inline_element (string name);
public Valadoc.Html.MarkupWriter image (string src, string? caption = null, string? css_class = null);
protected override bool inline_element (string name);
public Valadoc.Html.MarkupWriter javascript_link (string url);
public Valadoc.Html.MarkupWriter link (string url, string label, string? css_class = null);
public Valadoc.Html.MarkupWriter stylesheet_link (string url);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class SimpleChartFactory : Valadoc.Charts.SimpleFactory {
public SimpleChartFactory (Valadoc.Settings settings, Valadoc.Html.LinkHelper linker);
protected override Gvc.Node configure_type (Gvc.Node node, Valadoc.Api.Node item);
public override Gvc.Graph create_graph (Valadoc.Api.Node item);
}
}
namespace Importer {
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class DocumentationImporter : GLib.Object, Valadoc.ResourceLocator {
protected Valadoc.ModuleLoader modules;
protected Valadoc.Settings settings;
protected Valadoc.Api.Tree tree;
public DocumentationImporter (Valadoc.Api.Tree tree, Valadoc.ModuleLoader modules, Valadoc.Settings settings);
public abstract void process (string filename);
public virtual string resolve (string path);
public abstract string file_extension { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class GirDocumentationImporter : Valadoc.Importer.DocumentationImporter {
public GirDocumentationImporter (Valadoc.Api.Tree tree, Valadoc.DocumentationParser parser, Valadoc.ModuleLoader modules, Valadoc.Settings settings, Valadoc.ErrorReporter reporter);
public override void process (string source_file);
public override string file_extension { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class InternalIdRegistrar {
public InternalIdRegistrar ();
public Valadoc.Api.Node? map_symbol_id (string id);
public string? map_url_id (string id);
public void read_index_sgml_file (string filename, string? index_sgml_online, Valadoc.ErrorReporter reporter);
public void register_symbol (string id, Valadoc.Api.Node symbol);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ValadocDocumentationImporter : Valadoc.Importer.DocumentationImporter, Valadoc.ResourceLocator {
protected Valadoc.Content.ContentFactory factory;
public ValadocDocumentationImporter (Valadoc.Api.Tree tree, Valadoc.DocumentationParser parser, Valadoc.ModuleLoader modules, Valadoc.Settings settings, Valadoc.ErrorReporter reporter);
public override void process (string filename);
public override string file_extension { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ValadocDocumentationScanner : GLib.Object, Valadoc.Scanner {
public ValadocDocumentationScanner (Valadoc.Settings settings);
protected void accept (unichar c) throws Valadoc.ParserError;
public int get_line ();
public virtual string get_line_content ();
public virtual int get_line_start_column ();
protected unichar get_next_char (int offset = 1);
public virtual void reset ();
public virtual void stop ();
}
}
namespace ImporterHelper {
}
namespace Taglets {
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Deprecated : Valadoc.Content.BlockContent, Valadoc.Content.Taglet, Valadoc.Content.Block {
public Deprecated ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class InheritDoc : Valadoc.Content.InlineTaglet {
public InheritDoc ();
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override Valadoc.Rule? get_parser_rule (Valadoc.Rule run_rule);
public override bool is_empty ();
public override Valadoc.Content.ContentElement produce_content ();
public Valadoc.Api.Node? inherited { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Link : Valadoc.Content.InlineTaglet {
public Link ();
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override Valadoc.Rule? get_parser_rule (Valadoc.Rule run_rule);
public override bool is_empty ();
public override Valadoc.Content.ContentElement produce_content ();
public bool c_accept_plural { get; internal set; }
public bool c_is_plural { get; private set; }
public string symbol_name { get; internal set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Param : Valadoc.Content.BlockContent, Valadoc.Content.Taglet, Valadoc.Content.Block {
public Param ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public bool is_c_self_param { get; internal set; }
public bool is_this { get; private set; }
public Valadoc.Api.Symbol? parameter { get; private set; }
public string parameter_name { get; internal set; }
public int position { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Return : Valadoc.Content.BlockContent, Valadoc.Content.Taglet, Valadoc.Content.Block {
public Return ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class See : Valadoc.Content.ContentElement, Valadoc.Content.Taglet, Valadoc.Content.Block {
public See ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public Valadoc.Api.Node symbol { get; private set; }
public string symbol_name { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Since : Valadoc.Content.ContentElement, Valadoc.Content.Taglet, Valadoc.Content.Block {
public Since ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public override bool is_empty ();
public string version { get; internal set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Throws : Valadoc.Content.BlockContent, Valadoc.Content.Taglet, Valadoc.Content.Block {
public Throws ();
public override void accept (Valadoc.Content.ContentVisitor visitor);
public override void check (Valadoc.Api.Tree api_root, Valadoc.Api.Node container, string file_path, Valadoc.ErrorReporter reporter, Valadoc.Settings settings);
public override Valadoc.Content.ContentElement copy (Valadoc.Content.ContentElement? new_parent = null);
public Valadoc.Api.Node error_domain { get; private set; }
public string error_domain_name { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public static void init (Valadoc.ModuleLoader loader);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class CTypeResolver : Valadoc.Api.Visitor {
public CTypeResolver (Valadoc.Api.Tree tree);
public Valadoc.Api.Node? resolve_symbol (Valadoc.Api.Node? element, string _name);
public Valadoc.Api.TypeSymbol? resolve_symbol_type (string name);
public override void visit_class (Valadoc.Api.Class item);
public override void visit_constant (Valadoc.Api.Constant item);
public override void visit_delegate (Valadoc.Api.Delegate item);
public override void visit_enum (Valadoc.Api.Enum item);
public override void visit_enum_value (Valadoc.Api.EnumValue item);
public override void visit_error_code (Valadoc.Api.ErrorCode item);
public override void visit_error_domain (Valadoc.Api.ErrorDomain item);
public override void visit_field (Valadoc.Api.Field item);
public override void visit_interface (Valadoc.Api.Interface item);
public override void visit_method (Valadoc.Api.Method item);
public override void visit_namespace (Valadoc.Api.Namespace item);
public override void visit_package (Valadoc.Api.Package item);
public override void visit_property (Valadoc.Api.Property item);
public override void visit_signal (Valadoc.Api.Signal item);
public override void visit_struct (Valadoc.Api.Struct item);
public override void visit_tree (Valadoc.Api.Tree item);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class CommentScanner : Valadoc.WikiScanner {
public CommentScanner (Valadoc.Settings settings);
protected override void accept (unichar c) throws Valadoc.ParserError;
public override int get_line_start_column ();
public override void reset ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class DocumentationParser : GLib.Object, Valadoc.ResourceLocator {
public DocumentationParser (Valadoc.Settings settings, Valadoc.ErrorReporter reporter, Valadoc.Api.Tree tree, Valadoc.ModuleLoader modules);
public void check (Valadoc.Api.Node element, Valadoc.Content.Comment comment);
public void check_wikipage (Valadoc.Api.Package package, Valadoc.WikiPage page);
public Valadoc.Content.Comment? parse (Valadoc.Api.Node element, Valadoc.Api.SourceComment comment);
public Valadoc.Content.Comment? parse_comment_str (Valadoc.Api.Node element, string content, string filename, int first_line, int first_column);
public Valadoc.Content.Page? parse_wikipage (Valadoc.Api.Package pkg, Valadoc.WikiPage page);
public void transform_inheritdoc (Valadoc.Api.Node taglet_owner, Valadoc.Taglets.InheritDoc taglet);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ErrorReporter : GLib.Object {
public ErrorReporter (Valadoc.Settings? settings = null);
public void error (string file, long line, long startpos, long endpos, string errline, string msg_format, ...);
public void simple_error (string msg_format, ...);
public void simple_note (string msg_format, ...);
public void simple_warning (string msg_format, ...);
public void warning (string file, long line, long startpos, long endpos, string errline, string msg_format, ...);
public int errors { get; }
public int errors_offset { get; set; }
public Valadoc.Settings? settings { get; set; }
public GLib.FileStream stream { get; set; }
public int warnings { get; }
public int warnings_offset { get; set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class GirMetaData : GLib.Object {
public GirMetaData (string gir_file_path, string[] metadata_dirs, Valadoc.ErrorReporter reporter);
public string get_resource_path (string resource);
public string index_sgml { get; private set; }
public string index_sgml_online { get; private set; }
public bool is_docbook { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class GtkDocMarkupWriter : Valadoc.MarkupWriter {
public GtkDocMarkupWriter ();
protected override bool content_inline_element (string name);
protected override bool inline_element (string name);
public void reset ();
public string content { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class GtkdocRenderer : Valadoc.Content.ContentRenderer {
protected Valadoc.Settings settings;
public GtkdocRenderer ();
public void append_exceptions (Gee.List<Valadoc.Content.Taglet> taglets);
public void append_see (Gee.List<Valadoc.Content.Taglet> taglets);
public void append_since (Gee.List<Valadoc.Content.Taglet> taglets);
public override void render (Valadoc.Content.ContentElement element);
public override void render_children (Valadoc.Content.ContentElement element);
public void render_symbol (Valadoc.Content.Comment? documentation);
public override void visit_comment (Valadoc.Content.Comment element);
public override void visit_embedded (Valadoc.Content.Embedded element);
public override void visit_headline (Valadoc.Content.Headline element);
public override void visit_link (Valadoc.Content.Link element);
public override void visit_list (Valadoc.Content.List element);
public override void visit_list_item (Valadoc.Content.ListItem element);
public override void visit_note (Valadoc.Content.Note element);
public override void visit_page (Valadoc.Content.Page element);
public override void visit_paragraph (Valadoc.Content.Paragraph element);
public override void visit_run (Valadoc.Content.Run element);
public override void visit_source_code (Valadoc.Content.SourceCode element);
public override void visit_symbol_link (Valadoc.Content.SymbolLink element);
public override void visit_table (Valadoc.Content.Table element);
public override void visit_table_cell (Valadoc.Content.TableCell element);
public override void visit_table_row (Valadoc.Content.TableRow element);
public override void visit_text (Valadoc.Content.Text element);
public override void visit_warning (Valadoc.Content.Warning element);
public override void visit_wiki_link (Valadoc.Content.WikiLink element);
public void write_docbook_link (Valadoc.Api.Item item);
public void write_symbol_link (Valadoc.Content.SymbolLink element);
public string content { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class MarkupReader : GLib.Object {
public MarkupReader (string filename, Valadoc.ErrorReporter reporter);
public MarkupReader.from_string (string filename, string content, Valadoc.ErrorReporter reporter);
public string? get_attribute (string attr);
public Gee.Map<string,string> get_attributes ();
public string? get_line_content (int line_nr);
public Valadoc.MarkupTokenType read_token (out Valadoc.MarkupSourceLocation token_begin, out Valadoc.MarkupSourceLocation token_end);
public string content { get; private set; }
public string filename { get; private set; }
public string name { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class MarkupWriter {
public delegate void WriteFunc (string text);
protected long current_column;
protected int indent;
protected bool last_was_tag;
protected Valadoc.MarkupWriter.WriteFunc write;
public MarkupWriter (owned Valadoc.MarkupWriter.WriteFunc write, bool xml_declaration = true);
protected virtual bool content_inline_element (string name);
protected void do_write (string text);
public Valadoc.MarkupWriter end_tag (string name);
public static string escape (string txt);
protected virtual bool inline_element (string name);
public Valadoc.MarkupWriter raw_text (string text);
public void set_wrap (bool wrap);
public Valadoc.MarkupWriter simple_tag (string name, string[]? attributes = null);
public Valadoc.MarkupWriter start_tag (string name, string[]? attributes = null);
public Valadoc.MarkupWriter text (string text);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class ModuleLoader : GLib.Object {
public Valadoc.Doclet? create_doclet (string _path);
public Valadoc.Driver? create_driver (string _path);
public Valadoc.Content.Taglet? create_taglet (string keyword);
public static string get_doclet_path (string? docletpath, Valadoc.ErrorReporter reporter);
public static string? get_driver_path (string? _driverpath, Valadoc.ErrorReporter reporter);
public static Valadoc.ModuleLoader get_instance ();
public static bool is_doclet (string path);
public static bool is_driver (string path);
public void register_taglet (string keyword, GLib.Type type);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Parser : Valadoc.ParserCallback {
public Parser (Valadoc.Settings settings, Valadoc.Scanner scanner, Valadoc.ErrorReporter reporter);
public void accept_token (Valadoc.Token token) throws Valadoc.ParserError;
public void parse (string content, string filename, int first_line, int first_column) throws Valadoc.ParserError;
public void set_root_rule (Valadoc.Rule root_rule);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public abstract class Rule : GLib.Object {
public enum Forward {
NONE,
PARENT,
CHILD
}
public delegate void Action () throws Valadoc.ParserError;
protected Rule ();
public abstract bool accept_token (Valadoc.Token token, Valadoc.ParserCallback parser, Valadoc.Rule.Forward forward) throws Valadoc.ParserError;
protected void do_reduce (Valadoc.ParserCallback parser) throws Valadoc.ParserError;
protected void do_skip (Valadoc.ParserCallback parser) throws Valadoc.ParserError;
protected void do_start (Valadoc.ParserCallback parser) throws Valadoc.ParserError;
protected bool has_start_token (GLib.Object? scheme_element, Valadoc.Token token);
public abstract bool is_optional ();
protected bool is_optional_rule (GLib.Object? scheme_element);
public static Valadoc.Rule many (GLib.Object[] scheme);
public static Valadoc.Rule one_of (GLib.Object[] scheme);
public static Valadoc.Rule option (GLib.Object[] scheme);
public static Valadoc.Rule seq (GLib.Object[] scheme);
public Valadoc.Rule set_name (string name);
public Valadoc.Rule set_reduce (Valadoc.Rule.Action action);
public Valadoc.Rule set_skip (Valadoc.Rule.Action action);
public Valadoc.Rule set_start (Valadoc.Rule.Action action);
public abstract bool starts_with_token (Valadoc.Token token);
public abstract string to_string (GLib.Object? state);
protected bool try_to_apply (GLib.Object? scheme_element, Valadoc.Token token, Valadoc.ParserCallback parser, out bool handled) throws Valadoc.ParserError;
public abstract bool would_accept_token (Valadoc.Token token, GLib.Object? state);
public abstract bool would_reduce (Valadoc.Token token, GLib.Object? state);
public string name { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Settings : GLib.Object {
public bool _internal;
public bool _private;
public bool _protected;
public bool add_inherited;
public string? basedir;
public string[] defines;
public string? directory;
public bool experimental;
public bool experimental_non_null;
public string[] gir_directories;
public string? gir_directory;
public string? gir_name;
public string gir_namespace;
public string gir_version;
public string[] metadata_directories;
public string[] packages;
public string path;
public string pkg_name;
public string pkg_version;
public string[] pluginargs;
public string? profile;
public string[] source_files;
public string target_glib;
public string[] vapi_directories;
public bool verbose;
public string wiki_directory;
public bool with_deps;
public Settings ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class StubRule : Valadoc.Rule {
public StubRule ();
public override bool accept_token (Valadoc.Token token, Valadoc.ParserCallback parser, Valadoc.Rule.Forward forward) throws Valadoc.ParserError;
public override bool is_optional ();
public Valadoc.Rule set_rule (Valadoc.Rule rule);
public override bool starts_with_token (Valadoc.Token token);
public override string to_string (GLib.Object? state);
public override bool would_accept_token (Valadoc.Token token, GLib.Object? state);
public override bool would_reduce (Valadoc.Token token, GLib.Object? state);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class Token : GLib.Object {
public Token ();
public Token.from_type (Valadoc.TokenType type, Valadoc.SourceLocation begin, Valadoc.SourceLocation end, string? val = null);
public Token.from_word (string word, Valadoc.SourceLocation begin, Valadoc.SourceLocation end);
public int to_int ();
public string to_pretty_string ();
public string to_string ();
public Valadoc.SourceLocation begin { get; }
public Valadoc.SourceLocation end { get; }
public bool is_number { get; }
public bool is_word { get; }
public Valadoc.TokenType? token_type { get; }
public string? value { get; }
public string? word { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class TokenType : GLib.Object {
public delegate void Action (Valadoc.Token token) throws Valadoc.ParserError;
public static Valadoc.TokenType ALIGN_BOTTOM;
public static Valadoc.TokenType ALIGN_CENTER;
public static Valadoc.TokenType ALIGN_RIGHT;
public static Valadoc.TokenType ALIGN_TOP;
public static Valadoc.TokenType ANY;
public static Valadoc.TokenType ANY_NUMBER;
public static Valadoc.TokenType ANY_WORD;
public static Valadoc.TokenType AROBASE;
public static Valadoc.TokenType BACK_QUOTE_2;
public static Valadoc.TokenType BREAK;
public static Valadoc.TokenType CLOSED_BRACE;
public static Valadoc.TokenType DOUBLE_CLOSED_BRACE;
public static Valadoc.TokenType DOUBLE_CLOSED_BRACKET;
public static Valadoc.TokenType DOUBLE_OPEN_BRACE;
public static Valadoc.TokenType DOUBLE_OPEN_BRACKET;
public static Valadoc.TokenType DOUBLE_PIPE;
public static Valadoc.TokenType EOF;
public static Valadoc.TokenType EOL;
public static Valadoc.TokenType EQUAL_1;
public static Valadoc.TokenType EQUAL_2;
public static Valadoc.TokenType EQUAL_3;
public static Valadoc.TokenType EQUAL_4;
public static Valadoc.TokenType EQUAL_5;
public static Valadoc.TokenType GREATER_THAN;
public static Valadoc.TokenType LESS_THAN;
public static Valadoc.TokenType MARKDOWN_ANY_WORD;
public static Valadoc.TokenType MARKDOWN_BLOCK_END;
public static Valadoc.TokenType MARKDOWN_BLOCK_START;
public static Valadoc.TokenType MARKDOWN_CLOSE_BRACKET;
public static Valadoc.TokenType MARKDOWN_CLOSE_PARENS;
public static Valadoc.TokenType MARKDOWN_CONSTANT;
public static Valadoc.TokenType MARKDOWN_EOC;
public static Valadoc.TokenType MARKDOWN_EXCLAMATION_MARK;
public static Valadoc.TokenType MARKDOWN_FUNCTION;
public static Valadoc.TokenType MARKDOWN_GREATER_THAN;
public static Valadoc.TokenType MARKDOWN_HEADLINE_1;
public static Valadoc.TokenType MARKDOWN_HEADLINE_2;
public static Valadoc.TokenType MARKDOWN_HEADLINE_END;
public static Valadoc.TokenType MARKDOWN_HEADLINE_HASH;
public static Valadoc.TokenType MARKDOWN_LESS_THAN;
public static Valadoc.TokenType MARKDOWN_LINK;
public static Valadoc.TokenType MARKDOWN_LOCAL_GMEMBER;
public static Valadoc.TokenType MARKDOWN_MAIL;
public static Valadoc.TokenType MARKDOWN_OPEN_BRACKET;
public static Valadoc.TokenType MARKDOWN_OPEN_PARENS;
public static Valadoc.TokenType MARKDOWN_ORDERED_LIST_ITEM_END;
public static Valadoc.TokenType MARKDOWN_ORDERED_LIST_ITEM_START;
public static Valadoc.TokenType MARKDOWN_PARAGRAPH;
public static Valadoc.TokenType MARKDOWN_PARAMETER;
public static Valadoc.TokenType MARKDOWN_SOURCE;
public static Valadoc.TokenType MARKDOWN_SPACE;
public static Valadoc.TokenType MARKDOWN_SYMBOL;
public static Valadoc.TokenType MARKDOWN_UNORDERED_LIST_ITEM_END;
public static Valadoc.TokenType MARKDOWN_UNORDERED_LIST_ITEM_START;
public static Valadoc.TokenType MINUS;
public static Valadoc.TokenType OPEN_BRACE;
public static Valadoc.TokenType PIPE;
public static Valadoc.TokenType SINGLE_QUOTE_2;
public static Valadoc.TokenType SLASH_2;
public static Valadoc.TokenType SPACE;
public static Valadoc.TokenType TAB;
public static Valadoc.TokenType TRIPLE_CLOSED_BRACE;
public static Valadoc.TokenType TRIPLE_OPEN_BRACE;
public static Valadoc.TokenType UNDERSCORE_2;
public static Valadoc.TokenType VALADOC_ANY_WORD;
public static Valadoc.TokenType VALADOC_COMMENT_END;
public static Valadoc.TokenType VALADOC_COMMENT_START;
public static Valadoc.TokenType VALADOC_EOL;
public static Valadoc.TokenType VALADOC_SPACE;
public static Valadoc.TokenType VALADOC_TAB;
public Valadoc.TokenType action (Valadoc.TokenType.Action action);
public static Valadoc.TokenType any ();
public static Valadoc.TokenType any_number ();
public static Valadoc.TokenType any_word ();
public void do_action (Valadoc.Token matched_token) throws Valadoc.ParserError;
public bool matches (Valadoc.Token token);
public static Valadoc.TokenType str (string str);
public string to_pretty_string ();
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class WikiPage : GLib.Object, Valadoc.Documentation {
public WikiPage (string name, string path, Valadoc.Api.Package package);
public void parse (Valadoc.DocumentationParser docparser, Valadoc.Api.Package pkg);
public void read (Valadoc.ErrorReporter reporter);
public Valadoc.Content.Page documentation { get; protected set; }
public string documentation_str { get; private set; }
public string name { get; private set; }
public string path { get; private set; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class WikiPageTree : GLib.Object {
public WikiPageTree ();
public void check (Valadoc.Settings settings, Valadoc.DocumentationParser docparser, Valadoc.Api.Package pkg);
public Gee.Collection<Valadoc.WikiPage> get_pages ();
public void parse (Valadoc.Settings settings, Valadoc.DocumentationParser docparser, Valadoc.Api.Package package, Valadoc.ErrorReporter reporter);
public Valadoc.WikiPage? search (string name);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public class WikiScanner : GLib.Object, Valadoc.Scanner {
public WikiScanner (Valadoc.Settings settings);
protected virtual void accept (unichar c) throws Valadoc.ParserError;
public int get_line ();
public virtual string get_line_content ();
public virtual int get_line_start_column ();
protected unichar get_next_char (int offset = 1);
public virtual void reset ();
public void set_code_escape_mode (bool escape_mode);
public void set_url_escape_mode (bool escape_mode);
public virtual void stop ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Doclet : GLib.Object {
public abstract void process (Valadoc.Settings settings, Valadoc.Api.Tree tree, Valadoc.ErrorReporter reporter);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Documentation : GLib.Object {
public abstract string? get_filename ();
public abstract Valadoc.Api.Package? package { get; }
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Driver : GLib.Object {
public abstract Valadoc.Api.Tree? build (Valadoc.Settings settings, Valadoc.ErrorReporter reporter);
public abstract void write_gir (Valadoc.Settings settings, Valadoc.ErrorReporter reporter);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface ParserCallback {
public abstract void error (Valadoc.Token? token, string message) throws Valadoc.ParserError;
public abstract GLib.Object? get_rule_state ();
public abstract void push_rule (Valadoc.Rule rule);
public abstract void reduce ();
public abstract void set_rule_state (GLib.Object state);
public abstract void warning (Valadoc.Token? token, string message);
public abstract bool would_parent_accept_token (Valadoc.Token token);
public abstract bool would_parent_reduce_to_rule (Valadoc.Token token, Valadoc.Rule rule);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface ResourceLocator : GLib.Object {
public abstract string resolve (string path);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public interface Scanner : GLib.Object {
public abstract void end () throws Valadoc.ParserError;
public abstract string get_line_content ();
public abstract void reset ();
public abstract void scan (string content) throws Valadoc.ParserError;
public abstract void set_parser (Valadoc.Parser parser);
public abstract void stop ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public struct MarkupSourceLocation {
public char* pos;
public int line;
public int column;
public MarkupSourceLocation (char* _pos, int _line, int _column);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public struct SourceLocation {
public int line;
public int column;
public SourceLocation (int _line, int _column);
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum MarkupTokenType {
NONE,
COMMENT,
START_ELEMENT,
END_ELEMENT,
TEXT,
EOF;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public enum MethodBindingType {
UNMODIFIED,
OVERRIDE,
ABSTRACT,
VIRTUAL,
INLINE,
STATIC;
public string to_string ();
}
[CCode (cheader_filename = "valadoc-1.0.h")]
public errordomain ParserError {
INTERNAL_ERROR,
UNEXPECTED_TOKEN
}
[CCode (cheader_filename = "valadoc-1.0.h", has_target = false)]
public delegate GLib.Type DocletRegisterFunction (Valadoc.ModuleLoader module_loader);
[CCode (cheader_filename = "valadoc-1.0.h", has_target = false)]
public delegate GLib.Type DriverRegisterFunction (Valadoc.ModuleLoader module_loader);
[CCode (cheader_filename = "valadoc-1.0.h", has_target = false)]
public delegate void TagletRegisterFunction (Valadoc.ModuleLoader loader);
[CCode (cheader_filename = "valadoc-1.0.h", cname = "PACKAGE_ICONDIR", cprefix = "")]
public const string icons_dir;
[CCode (cheader_filename = "valadoc-1.0.h")]
public static bool copy_directory (string src, string dest);
[CCode (cheader_filename = "valadoc-1.0.h")]
public static bool copy_file (string src, string dest);
[CCode (cheader_filename = "valadoc-1.0.h")]
public static string realpath (string name);
[CCode (cheader_filename = "valadoc-1.0.h")]
public static bool remove_directory (string rpath);
}
|