Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Despite its name, gtkdoc doesn't require gtk+ and is a nice way to generate DocBook format API documentation.
- Loading branch information
Kristian Høgsberg
committed
Jun 23, 2008
1 parent
ef514b2
commit 13de660
Showing
8 changed files
with
326 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
<?xml version="1.0"?> | ||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | ||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ | ||
<!ENTITY version SYSTEM "version.xml"> | ||
]> | ||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> | ||
<bookinfo> | ||
<title>Razor Library Reference Manual</title> | ||
<releaseinfo>Version &version;</releaseinfo> | ||
<authorgroup> | ||
<author> | ||
<firstname>Kristian</firstname> | ||
<surname>Høgsberg</surname> | ||
<affiliation> | ||
<address> | ||
<email>krh@redhat.com</email> | ||
</address> | ||
</affiliation> | ||
</author> | ||
</authorgroup> | ||
|
||
<copyright> | ||
<year>2008</year> | ||
<holder>Razor Authors</holder> | ||
</copyright> | ||
|
||
<copyright> | ||
<year>2008</year> | ||
<holder>Red Hat, Inc</holder> | ||
</copyright> | ||
|
||
<legalnotice> | ||
<para> | ||
Permission is granted to copy, distribute and/or modify this | ||
document under the terms of the <citetitle>GNU Free | ||
Documentation License</citetitle>, Version 1.1 or any later | ||
version published by the Free Software Foundation with no | ||
Invariant Sections, no Front-Cover Texts, and no Back-Cover | ||
Texts. You may obtain a copy of the <citetitle>GNU Free | ||
Documentation License</citetitle> from the Free Software | ||
Foundation by visiting <ulink type="http" | ||
url="http://www.fsf.org">their Web site</ulink> or by writing | ||
to: | ||
|
||
<address> | ||
The Free Software Foundation, Inc., | ||
<street>59 Temple Place</street> - Suite 330, | ||
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>, | ||
<country>USA</country> | ||
</address> | ||
</para> | ||
</legalnotice> | ||
</bookinfo> | ||
|
||
<reference id="ref-design"> | ||
<title>Design Overview</title> | ||
<partintro> | ||
<para> | ||
This part presents the design documentation for razor. | ||
</para> | ||
</partintro> | ||
</reference> | ||
|
||
<reference id="ref-core"> | ||
<title>Core API Reference</title> | ||
<partintro> | ||
<para> | ||
This part presents the class and function reference for the | ||
core razor library. | ||
</para> | ||
</partintro> | ||
<xi:include href="xml/set.xml"/> | ||
<xi:include href="xml/importer.xml"/> | ||
<xi:include href="xml/iterator.xml"/> | ||
<xi:include href="xml/transaction.xml"/> | ||
<xi:include href="xml/rpm.xml"/> | ||
<xi:include href="xml/root.xml"/> | ||
<xi:include href="xml/misc.xml"/> | ||
</reference> | ||
|
||
<index> | ||
<title>Index</title> | ||
</index> | ||
|
||
</book> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
<SECTION> | ||
<FILE>set</FILE> | ||
razor_set | ||
razor_set_create | ||
razor_set_open | ||
razor_set_destroy | ||
razor_set_write_to_fd | ||
razor_set_write | ||
razor_set_open_details | ||
razor_set_open_files | ||
razor_set_get_package | ||
razor_set_list_files | ||
razor_set_list_package_files | ||
razor_set_list_unsatisfied | ||
razor_set_create_from_yum | ||
razor_set_create_from_rpmdb | ||
razor_diff_callback_t | ||
razor_set_diff | ||
razor_set_create_remove_iterator | ||
razor_set_create_install_iterator | ||
</SECTION> | ||
|
||
<SECTION> | ||
<FILE>transaction</FILE> | ||
razor_transaction_create | ||
razor_transaction_install_package | ||
razor_transaction_remove_package | ||
razor_transaction_update_package | ||
razor_transaction_update_all | ||
razor_transaction_resolve | ||
razor_transaction_describe | ||
razor_transaction_finish | ||
razor_transaction_destroy | ||
razor_transaction_unsatisfied_property | ||
</SECTION> | ||
|
||
<SECTION> | ||
<FILE>importer</FILE> | ||
razor_importer | ||
razor_importer_create | ||
razor_importer_destroy | ||
razor_importer_begin_package | ||
razor_importer_add_details | ||
razor_importer_add_property | ||
razor_importer_add_file | ||
razor_importer_finish_package | ||
razor_importer_add_rpm | ||
razor_importer_finish | ||
</SECTION> | ||
|
||
<SECTION> | ||
<FILE>rpm</FILE> | ||
razor_rpm | ||
razor_rpm_open | ||
razor_rpm_install | ||
razor_rpm_close | ||
</SECTION> | ||
|
||
<SECTION> | ||
<FILE>root</FILE> | ||
razor_root | ||
razor_root_create | ||
razor_root_open | ||
razor_root_open_read_only | ||
razor_root_get_system_set | ||
razor_root_close | ||
razor_root_update | ||
razor_root_commit | ||
</SECTION> | ||
|
||
<SECTION> | ||
<FILE>iterator</FILE> | ||
razor_package_iterator | ||
razor_package_iterator_create | ||
razor_package_iterator_create_for_property | ||
razor_package_iterator_create_for_file | ||
razor_package_iterator_next | ||
razor_package_iterator_destroy | ||
razor_package_query_create | ||
razor_package_query_add_package | ||
razor_package_query_add_iterator | ||
razor_package_query_finish | ||
razor_property_iterator | ||
razor_property_iterator_create | ||
razor_property_iterator_next | ||
razor_property_iterator_destroy | ||
</SECTION> | ||
|
||
<SECTION> | ||
<FILE>misc</FILE> | ||
razor_package | ||
razor_package_get_details | ||
|
||
razor_property | ||
razor_property_relation_to_string | ||
razor_property_type_to_string | ||
|
||
razor_build_evr | ||
razor_versioncmp | ||
</SECTION> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
@VERSION@ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.