The generator doesn't make a very good job of guestfs-sections.txt. This change manually fixes its title, and moves various sections which shouldn't be in the documentation into a Private subsection. This change requires removing the --rebuild-sections command line option from gtkdoc-scan. This means that any future apis will have to be manually added to guestfs-sections.txt if they are to appear in the gtk-doc output. --- gobject/docs/Makefile.am | 3 +- gobject/docs/guestfs-sections.txt | 126 ++++++++++++++++--------------------- 2 files changed, 57 insertions(+), 72 deletions(-) diff --git a/gobject/docs/Makefile.am b/gobject/docs/Makefile.am index 0dd43f6..8988bc5 100644 --- a/gobject/docs/Makefile.am +++ b/gobject/docs/Makefile.am @@ -29,7 +29,8 @@ SCANGOBJ_OPTIONS= # Extra options to supply to gtkdoc-scan. # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" -SCAN_OPTIONS=--rebuild-sections --rebuild-types +#SCAN_OPTIONS=--rebuild-sections --rebuild-types +SCAN_OPTIONS=--rebuild-types # Extra options to supply to gtkdoc-mkdb. # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml diff --git a/gobject/docs/guestfs-sections.txt b/gobject/docs/guestfs-sections.txt index 19b0de8..8cbaa32 100644 --- a/gobject/docs/guestfs-sections.txt +++ b/gobject/docs/guestfs-sections.txt @@ -1,80 +1,41 @@ <SECTION> <FILE>guestfs-gobject</FILE> -<TITLE>GuestfsAddDomain</TITLE> -<TITLE>GuestfsAddDriveOpts</TITLE> -<TITLE>GuestfsBTRFSFilesystemResize</TITLE> -<TITLE>GuestfsCompressDeviceOut</TITLE> -<TITLE>GuestfsCompressOut</TITLE> -<TITLE>GuestfsCopyDeviceToDevice</TITLE> -<TITLE>GuestfsCopyDeviceToFile</TITLE> -<TITLE>GuestfsCopyFileToDevice</TITLE> -<TITLE>GuestfsCopyFileToFile</TITLE> -<TITLE>GuestfsE2fsck</TITLE> -<TITLE>GuestfsInspectGetIcon</TITLE> -<TITLE>GuestfsMDCreate</TITLE> -<TITLE>GuestfsMkfsOpts</TITLE> -<TITLE>GuestfsMount9P</TITLE> -<TITLE>GuestfsNTFSResizeOpts</TITLE> -<TITLE>GuestfsNtfscloneOut</TITLE> -<TITLE>GuestfsNtfsfix</TITLE> -<TITLE>GuestfsSession</TITLE> -<TITLE>GuestfsTest0</TITLE> -<TITLE>GuestfsTune2FS</TITLE> +<TITLE>Guestfs</TITLE> +GuestfsSession GuestfsAddDomain -GuestfsAddDomainClass GuestfsAddDriveOpts -GuestfsAddDriveOptsClass GuestfsApplication GuestfsBTRFSFilesystemResize -GuestfsBTRFSFilesystemResizeClass GuestfsCompressDeviceOut -GuestfsCompressDeviceOutClass GuestfsCompressOut -GuestfsCompressOutClass GuestfsCopyDeviceToDevice -GuestfsCopyDeviceToDeviceClass GuestfsCopyDeviceToFile -GuestfsCopyDeviceToFileClass GuestfsCopyFileToDevice -GuestfsCopyFileToDeviceClass GuestfsCopyFileToFile -GuestfsCopyFileToFileClass GuestfsDirent GuestfsE2fsck -GuestfsE2fsckClass GuestfsINotifyEvent GuestfsISOInfo GuestfsInspectGetIcon -GuestfsInspectGetIconClass GuestfsIntBool GuestfsLV GuestfsMDCreate -GuestfsMDCreateClass GuestfsMDStat GuestfsMkfsOpts -GuestfsMkfsOptsClass GuestfsMount9P -GuestfsMount9PClass GuestfsNTFSResizeOpts -GuestfsNTFSResizeOptsClass GuestfsNtfscloneOut -GuestfsNtfscloneOutClass GuestfsNtfsfix -GuestfsNtfsfixClass GuestfsPV GuestfsPartition -GuestfsSession -GuestfsSessionClass GuestfsStat GuestfsStatVFS -GuestfsTest0 -GuestfsTest0Class GuestfsTristate GuestfsTune2FS -GuestfsTune2FSClass GuestfsVG GuestfsVersion GuestfsXAttr +guestfs_session_new guestfs_add_domain_new guestfs_add_drive_opts_new guestfs_btrfs_filesystem_resize_new @@ -337,7 +298,6 @@ guestfs_session_mount_vfs guestfs_session_mountpoints guestfs_session_mounts guestfs_session_mv -guestfs_session_new guestfs_session_ntfs_3g_probe guestfs_session_ntfsclone_in guestfs_session_ntfsclone_out @@ -432,29 +392,6 @@ guestfs_session_tail guestfs_session_tail_n guestfs_session_tar_in guestfs_session_tar_out -guestfs_session_test0 -guestfs_session_test0rbool -guestfs_session_test0rboolerr -guestfs_session_test0rbufferout -guestfs_session_test0rbufferouterr -guestfs_session_test0rconstoptstring -guestfs_session_test0rconstoptstringerr -guestfs_session_test0rconststring -guestfs_session_test0rconststringerr -guestfs_session_test0rhashtable -guestfs_session_test0rhashtableerr -guestfs_session_test0rint -guestfs_session_test0rint64 -guestfs_session_test0rint64err -guestfs_session_test0rinterr -guestfs_session_test0rstring -guestfs_session_test0rstringerr -guestfs_session_test0rstringlist -guestfs_session_test0rstringlisterr -guestfs_session_test0rstruct -guestfs_session_test0rstructerr -guestfs_session_test0rstructlist -guestfs_session_test0rstructlisterr guestfs_session_tgz_in guestfs_session_tgz_out guestfs_session_touch @@ -505,8 +442,6 @@ guestfs_session_zfgrepi guestfs_session_zfile guestfs_session_zgrep guestfs_session_zgrepi -guestfs_test0_new -guestfs_tune2fs_new <SUBSECTION Standard> GUESTFS_ADD_DOMAIN GUESTFS_ADD_DOMAIN_CLASS @@ -629,6 +564,27 @@ GUESTFS_TYPE_SESSION GUESTFS_TYPE_TEST0 GUESTFS_TYPE_TRISTATE GUESTFS_TYPE_TUNE2FS +<SUBSECTION Private> +GuestfsAddDomainClass +GuestfsAddDriveOptsClass +GuestfsBTRFSFilesystemResizeClass +GuestfsCompressDeviceOutClass +GuestfsCompressOutClass +GuestfsCopyDeviceToDeviceClass +GuestfsCopyDeviceToFileClass +GuestfsCopyFileToDeviceClass +GuestfsCopyFileToFileClass +GuestfsE2fsckClass +GuestfsInspectGetIconClass +GuestfsMDCreateClass +GuestfsMkfsOptsClass +GuestfsMount9PClass +GuestfsNtfscloneOutClass +GuestfsNtfsfixClass +GuestfsNTFSResizeOptsClass +GuestfsSessionClass +GuestfsTune2FSClass + GuestfsAddDomainPrivate GuestfsAddDriveOptsPrivate GuestfsBTRFSFilesystemResizePrivate @@ -647,8 +603,8 @@ GuestfsNTFSResizeOptsPrivate GuestfsNtfscloneOutPrivate GuestfsNtfsfixPrivate GuestfsSessionPrivate -GuestfsTest0Private GuestfsTune2FSPrivate + guestfs_add_domain_get_type guestfs_add_drive_opts_get_type guestfs_application_get_type @@ -680,10 +636,38 @@ guestfs_session_get_type guestfs_session_inspect_get_type guestfs_stat_get_type guestfs_statvfs_get_type -guestfs_test0_get_type guestfs_tristate_get_type guestfs_tune2fs_get_type guestfs_version_get_type guestfs_xattr_get_type -</SECTION> +GuestfsTest0 +GuestfsTest0Class +GuestfsTest0Private +guestfs_session_test0 +guestfs_session_test0rbool +guestfs_session_test0rboolerr +guestfs_session_test0rbufferout +guestfs_session_test0rbufferouterr +guestfs_session_test0rconstoptstring +guestfs_session_test0rconstoptstringerr +guestfs_session_test0rconststring +guestfs_session_test0rconststringerr +guestfs_session_test0rhashtable +guestfs_session_test0rhashtableerr +guestfs_session_test0rint +guestfs_session_test0rint64 +guestfs_session_test0rint64err +guestfs_session_test0rinterr +guestfs_session_test0rstring +guestfs_session_test0rstringerr +guestfs_session_test0rstringlist +guestfs_session_test0rstringlisterr +guestfs_session_test0rstruct +guestfs_session_test0rstructerr +guestfs_session_test0rstructlist +guestfs_session_test0rstructlisterr +guestfs_test0_new +guestfs_tune2fs_new +guestfs_test0_get_type +</SECTION> -- 1.7.7.6