packaging/ostree
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Get API docs working again

Browse Source 
This changes around a few things that didn't work for me:
* Section names seem to be ostree-* instead of libostree-*
* Also XML files are ostree-* (they didn't show up at all)
- gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly
* pull documentation is now on the actual functions rather than stubs
* Update gitignore with some more files

And there some changes to make gtk-doc give fewer warnings (not finished)

Closes: #327
Approved by: cgwalters
This commit is contained in:
Mathnerd314 authored and Atomic Bot committed 2016-06-09 18:15:49 +00:00
1 parent 693b4ec4be
commit 1b88dc7f90
22 files changed
+186 -114
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apidoc/.gitignore
+2
View File
@@ -32,6 +32,7 @@
/ostree.args
/ostree.hierarchy
/ostree.interfaces
/ostree-overrides.txt
/ostree.pdf
/ostree.prerequisites
/ostree.signals
@@ -48,4 +49,5 @@
/tmpl/*.bak
/tmpl/ostree-unused.sgml
/xml
/version.xml
_libs
apidoc/ostree-docs.xml
+14 -16
View File
@@ -13,25 +13,23 @@
<chapter xml:id="reference">
<title>API Reference</title>
<xi:include href="xml/libostree-core.xml"/>
<xi:include href="xml/libostree-repo.xml"/>
<xi:include href="xml/libostree-mutable-tree.xml"/>
<xi:include href="xml/libostree-sysroot.xml"/>
<xi:include href="xml/libostree-async-progress.xml"/>
<xi:include href="xml/libostree-sepolicy.xml"/>
<xi:include href="xml/libostree-sysroot-upgrader.xml"/>
<xi:include href="xml/libostree-gpg-verify-result.xml"/>
<xi:include href="xml/libostree-bootconfig-parser.xml"/>
<xi:include href="xml/libostree-chain-input-stream.xml"/>
<xi:include href="xml/libostree-checksum-input-stream.xml"/>
<xi:include href="xml/libostree-deployment.xml"/>
<xi:include href="xml/libostree-diff.xml"/>
<xi:include href="xml/libostree-repo-file.xml"/>
<xi:include href="xml/ostree-core.xml"/>
<xi:include href="xml/ostree-repo.xml"/>
<xi:include href="xml/ostree-mutable-tree.xml"/>
<xi:include href="xml/ostree-sysroot.xml"/>
<xi:include href="xml/ostree-async-progress.xml"/>
<xi:include href="xml/ostree-sepolicy.xml"/>
<xi:include href="xml/ostree-sysroot-upgrader.xml"/>
<xi:include href="xml/ostree-gpg-verify-result.xml"/>
<xi:include href="xml/ostree-bootconfig-parser.xml"/>
<xi:include href="xml/ostree-chain-input-stream.xml"/>
<xi:include href="xml/ostree-checksum-input-stream.xml"/>
<xi:include href="xml/ostree-deployment.xml"/>
<xi:include href="xml/ostree-diff.xml"/>
<xi:include href="xml/ostree-repo-file.xml"/>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
</chapter>
</book>
apidoc/ostree-sections.txt
+39 -14
View File
@@ -1,5 +1,5 @@
<SECTION>
<FILE>libostree-async-progress</FILE>
<FILE>ostree-async-progress</FILE>
OstreeAsyncProgress
ostree_async_progress_new
ostree_async_progress_new_and_connect
@@ -22,7 +22,7 @@ ostree_async_progress_get_type
</SECTION>
<SECTION>
<FILE>libostree-bootconfig-parser</FILE>
<FILE>ostree-bootconfig-parser</FILE>
OstreeBootconfigParser
ostree_bootconfig_parser_new
ostree_bootconfig_parser_clone
@@ -40,7 +40,7 @@ ostree_bootconfig_parser_get_type
</SECTION>
<SECTION>
<FILE>libostree-chain-input-stream</FILE>
<FILE>ostree-chain-input-stream</FILE>
OstreeChainInputStream
ostree_chain_input_stream_new
<SUBSECTION Standard>
@@ -56,7 +56,7 @@ ostree_chain_input_stream_get_type
</SECTION>
<SECTION>
<FILE>libostree-checksum-input-stream</FILE>
<FILE>ostree-checksum-input-stream</FILE>
OstreeChecksumInputStream
ostree_checksum_input_stream_new
<SUBSECTION Standard>
@@ -72,7 +72,7 @@ ostree_checksum_input_stream_get_type
</SECTION>
<SECTION>
<FILE>libostree-core</FILE>
<FILE>ostree-core</FILE>
OSTREE_MAX_METADATA_SIZE
OSTREE_MAX_METADATA_WARN_SIZE
OSTREE_MAX_RECURSION
@@ -133,7 +133,7 @@ ostree_commit_get_timestamp
</SECTION>
<SECTION>
<FILE>libostree-deployment</FILE>
<FILE>ostree-deployment</FILE>
OstreeDeployment
ostree_deployment_hash
ostree_deployment_equal
@@ -162,7 +162,7 @@ ostree_deployment_get_type
</SECTION>
<SECTION>
<FILE>libostree-diff</FILE>
<FILE>ostree-diff</FILE>
OstreeDiffFlags
OstreeDiffItem
ostree_diff_item_ref
@@ -174,7 +174,7 @@ ostree_diff_item_get_type
</SECTION>
<SECTION>
<FILE>libostree-gpg-verify-result</FILE>
<FILE>ostree-gpg-verify-result</FILE>
OstreeGpgVerifyResult
OstreeGpgSignatureAttr
ostree_gpg_verify_result_count_all
@@ -193,8 +193,33 @@ OSTREE_TYPE_GPG_VERIFY_RESULT
ostree_gpg_verify_result_get_type
</SECTION>
<FILE>ostree-lzma-compressor</FILE>
<SUBSECTION Standard>
OSTREE_IS_LZMA_COMPRESSOR
OSTREE_IS_LZMA_COMPRESSOR_CLASS
OSTREE_LZMA_COMPRESSOR
OSTREE_LZMA_COMPRESSOR_CLASS
OSTREE_LZMA_COMPRESSOR_GET_CLASS
OSTREE_TYPE_LZMA_COMPRESSOR
OstreeLzmaCompressor
OstreeLzmaCompressorClass
</SECTION>
<SECTION>
<FILE>libostree-mutable-tree</FILE>
<FILE>ostree-lzma-decompressor</FILE>
<SUBSECTION Standard>
OSTREE_IS_LZMA_DECOMPRESSOR
OSTREE_IS_LZMA_DECOMPRESSOR_CLASS
OSTREE_LZMA_DECOMPRESSOR
OSTREE_LZMA_DECOMPRESSOR_CLASS
OSTREE_LZMA_DECOMPRESSOR_GET_CLASS
OSTREE_TYPE_LZMA_DECOMPRESSOR
OstreeLzmaDecompressor
OstreeLzmaDecompressorClass
</SECTION>
<SECTION>
<FILE>ostree-mutable-tree</FILE>
OstreeMutableTree
ostree_mutable_tree_new
ostree_mutable_tree_set_metadata_checksum
@@ -220,7 +245,7 @@ ostree_mutable_tree_get_type
</SECTION>
<SECTION>
<FILE>libostree-repo</FILE>
<FILE>ostree-repo</FILE>
OstreeRepo
OstreeRepoMode
ostree_repo_mode_from_string
@@ -362,7 +387,7 @@ ostree_repo_transaction_stats_get_type
</SECTION>
<SECTION>
<FILE>libostree-repo-file</FILE>
<FILE>ostree-repo-file</FILE>
OstreeRepoFile
ostree_repo_file_ensure_resolved
ostree_repo_file_get_xattrs
@@ -388,7 +413,7 @@ ostree_repo_file_get_type
</SECTION>
<SECTION>
<FILE>libostree-sepolicy</FILE>
<FILE>ostree-sepolicy</FILE>
OstreeSePolicy
ostree_sepolicy_new
ostree_sepolicy_get_path
@@ -407,7 +432,7 @@ ostree_sepolicy_get_type
</SECTION>
<SECTION>
<FILE>libostree-sysroot</FILE>
<FILE>ostree-sysroot</FILE>
OstreeSysroot
ostree_sysroot_new
ostree_sysroot_new_default
@@ -451,7 +476,7 @@ ostree_sysroot_get_type
</SECTION>
<SECTION>
<FILE>libostree-sysroot-upgrader</FILE>
<FILE>ostree-sysroot-upgrader</FILE>
OstreeSysrootUpgrader
ostree_sysroot_upgrader_new
ostree_sysroot_upgrader_new_for_os