The gtk-doc errors

[Philip Van Hoof <spam pvanhoof be>]

These are the remaining gtk-doc errors and the undocumented symbols
(errors follow the undocumented symbols):

Everybody who has some free time is hereby permitted to throw symbol
documentation at my head. I'll give you a good Belgian beer or five at
FOSDEM if you single handed achieve pushing up the percentage to 80%.



64% symbol docs coverage.
561 symbols documented.
4 symbols incomplete.
319 not documented.


RefreshStatusInfo
TINYMAIL_ENABLE_PRIVATE_API
TNY_ASYNC_WORKER_QUEUE_GET_PRIVATE
TNY_ASYNC_WORKER_QUEUE_TASK_GET_PRIVATE
TNY_CAMEL_ACCOUNT
TNY_CAMEL_ACCOUNT_CLASS
TNY_CAMEL_ACCOUNT_GET_CLASS
TNY_CAMEL_ACCOUNT_GET_PRIVATE
TNY_CAMEL_FOLDER_GET_PRIVATE
TNY_CAMEL_MIME_PART_GET_PRIVATE
TNY_CAMEL_POP_STORE_ACCOUNT_GET_PRIVATE
TNY_CAMEL_STORE_ACCOUNT_GET_PRIVATE
TNY_CAMEL_STREAM_GET_PRIVATE
TNY_FOLDER_PRIV_GET_MSG_QUEUE
TNY_FOLDER_PRIV_GET_QUEUE
TNY_FOLDER_PRIV_GET_SESSION
TNY_FOLDER_STORE_QUERY_ITEM
TNY_FOLDER_STORE_QUERY_ITEM_CLASS
TNY_FOLDER_STORE_QUERY_ITEM_GET_CLASS
TNY_GENERIC_SEND_QUEUE_GET_PRIVATE
TNY_GET_MSG_QUEUE_GET_PRIVATE
TNY_GNOME_DEVICE_GET_PRIVATE
TNY_GTK_HEADER_LIST_MODEL_GET_PRIVATE
TNY_IS_CAMEL_ACCOUNT
TNY_IS_FOLDER_STORE_QUERY_ITEM
TNY_IS_FOLDER_STORE_QUERY_ITEM_CLASS
TNY_SIMPLE_LIST_GET_PRIVATE
TNY_STREAM_CAMEL
TNY_STREAM_CAMEL_CLASS
TNY_TYPE_ACCOUNT_SIGNAL
TNY_TYPE_ACCOUNT_STORE_SIGNAL
TNY_TYPE_ACCOUNT_TYPE
TNY_TYPE_ALERT_TYPE
TNY_TYPE_CAMEL_ACCOUNT
TNY_TYPE_CONNECTION_STATUS
TNY_TYPE_DEVICE_SIGNAL
TNY_TYPE_ERROR
TNY_TYPE_ERROR_DOMAIN
TNY_TYPE_FOLDER_CAPS
TNY_TYPE_FOLDER_CHANGE_CHANGED
TNY_TYPE_FOLDER_SIGNAL
TNY_TYPE_FOLDER_STORE_CHANGE_CHANGED
TNY_TYPE_FOLDER_STORE_QUERY_ITEM
TNY_TYPE_FOLDER_STORE_QUERY_OPTION
TNY_TYPE_FOLDER_TYPE
TNY_TYPE_GET_ACCOUNTS_REQUEST_TYPE
TNY_TYPE_GTK_ACCOUNT_LIST_MODEL_COLUMN
TNY_TYPE_GTK_ATTACH_LIST_MODEL_COLUMN
TNY_TYPE_GTK_FOLDER_STORE_TREE_MODEL_COLUMN
TNY_TYPE_GTK_HEADER_LIST_MODEL_COLUMN
TNY_TYPE_HEADER_FLAGS
TNY_TYPE_HEADER_PRIORITY_FLAGS
TNY_TYPE_SEND_QUEUE_SIGNAL
TNY_TYPE_STATUS_CODE
TNY_TYPE_STATUS_DOMAIN
TNY_TYPE_STORE_ACCOUNT_SIGNAL
TNY_TYPE_STREAM_CAMEL
TNY_TYPE_STREAM_CAMEL_STREAM
TnyAccount
TnyAccountIface
TnyAccountSignal
TnyAccountStore
TnyAccountStoreIface
TnyAccountStoreSignal
TnyAccountStoreView
TnyAccountStoreViewIface
TnyAccountType
TnyAlertType
TnyAsyncWorkerQueue
TnyAsyncWorkerQueuePriv
TnyAsyncWorkerQueueTask
TnyAsyncWorkerQueueTaskPriv
TnyCamelAccount
TnyCamelAccountPriv
TnyCamelFolder
TnyCamelFolderPriv
TnyCamelFullMsgReceiveStrategy
TnyCamelHeader
TnyCamelIMAPFolder
TnyCamelIMAPStoreAccount
TnyCamelMemStream
TnyCamelMimePart
TnyCamelMimePartPriv
TnyCamelMsg
TnyCamelMsgHeader
TnyCamelMsgPriv
TnyCamelMsgRemoveStrategy
TnyCamelNNTPFolder
TnyCamelNNTPStoreAccount
TnyCamelPOPFolder
TnyCamelPOPStoreAccount
TnyCamelPartialMsgReceiveStrategy
TnyCamelPopRemoteMsgRemoveStrategy
TnyCamelPopStoreAccountPriv
TnyCamelQueue
TnyCamelSendQueue
TnyCamelSendQueuePriv
TnyCamelStoreAccount
TnyCamelStoreAccountPriv
TnyCamelStream
TnyCamelStreamPriv
TnyCamelTransportAccount
TnyCamelTransportAccountPriv
TnyCombinedAccount
TnyCombinedAccountClass
TnyConnectionStatus
TnyCopyFolderCallback
TnyDevice
TnyDeviceIface
TnyDeviceSignal
TnyError (TNY_FOLDER_ERROR_SYNC,
TNY_TRANSPORT_ACCOUNT_ERROR_SEND_HOST_LOOKUP_FAILED,
TNY_TRANSPORT_ACCOUNT_ERROR_SEND_SERVICE_UNAVAILABLE,
TNY_TRANSPORT_ACCOUNT_ERROR_SEND_AUTHENTICATION_NOT_SUPPORTED,
TNY_TRANSPORT_ACCOUNT_ERROR_SEND_USER_CANCEL,
TNY_ACCOUNT_ERROR_TRY_CONNECT_HOST_LOOKUP_FAILED,
TNY_ACCOUNT_ERROR_TRY_CONNECT_SERVICE_UNAVAILABLE,
TNY_ACCOUNT_ERROR_TRY_CONNECT_AUTHENTICATION_NOT_SUPPORTED,
TNY_ACCOUNT_ERROR_TRY_CONNECT_CERTIFICATE,
TNY_ACCOUNT_ERROR_TRY_CONNECT_USER_CANCEL,
TNY_ACCOUNT_STORE_ERROR_UNKNOWN_ALERT,
TNY_ACCOUNT_ERROR_GET_SUPPORTED_AUTH, TNY_SEND_QUEUE_ERROR_ADD,
TNY_ACCOUNT_STORE_ERROR_CANCEL_ALERT)
TnyErrorDomain
TnyFolder
TnyFolderCaps
TnyFolderChange
TnyFolderChangeChanged
TnyFolderChangeClass
TnyFolderIface
TnyFolderMonitor
TnyFolderMonitorClass
TnyFolderObserver
TnyFolderObserverIface
TnyFolderSignal
TnyFolderStats
TnyFolderStatsClass
TnyFolderStore
TnyFolderStoreChange
TnyFolderStoreChangeChanged
TnyFolderStoreChangeClass
TnyFolderStoreIface
TnyFolderStoreObserver
TnyFolderStoreObserverIface
TnyFolderStoreQuery
TnyFolderStoreQueryClass
TnyFolderStoreQueryItem
TnyFolderStoreQueryItemClass
TnyFolderStoreQueryOption
TnyFolderType
TnyFsStream
TnyFsStreamClass
TnyGenericSendQueue
TnyGenericSendQueuePriv
TnyGetAccountsRequestType
TnyGetMsgCallback (cancelled)
TnyGetMsgQueue
TnyGetMsgQueuePriv
TnyGnomeAccountStore
TnyGnomeDevice
TnyGnomeDevicePriv
TnyGnomePlatformFactory
TnyGtkAccountListModel
TnyGtkAccountListModelColumn
TnyGtkAccountListModelIterator
TnyGtkAttachListModel
TnyGtkAttachListModelColumn
TnyGtkAttachListModelIterator
TnyGtkAttachListModelPriv
TnyGtkAttachmentMimePartView
TnyGtkFolderStoreTreeModel
TnyGtkFolderStoreTreeModelColumn
TnyGtkFolderStoreTreeModelIterator
TnyGtkHeaderListIterator
TnyGtkHeaderListModel
TnyGtkHeaderListModelColumn
TnyGtkHeaderListModelPriv
TnyGtkHeaderView
TnyGtkLockable
TnyGtkMimePartSaveStrategy
TnyGtkMsgView
TnyGtkPasswordDialog
TnyGtkTextBufferStream
TnyGtkTextMimePartView
TnyHeader
TnyHeaderIface
TnyHeaderPriorityFlags
TnyHeaderView
TnyHeaderViewIface
TnyIterator
TnyIteratorIface
TnyList
TnyListIface
TnyLockable
TnyLockableIface
TnyMergeFolder
TnyMimePart
TnyMimePartIface
TnyMimePartSaveStrategy
TnyMimePartSaveStrategyIface
TnyMimePartSaver
TnyMimePartSaverIface
TnyMimePartView
TnyMimePartViewIface
TnyMozEmbedHtmlMimePartView
TnyMozEmbedMsgView
TnyMozEmbedStream
TnyMozEmbedStreamPriv
TnyMsg
TnyMsgIface
TnyMsgReceiveStrategy
TnyMsgReceiveStrategyIface
TnyMsgRemoveStrategy
TnyMsgRemoveStrategyIface
TnyMsgView
TnyMsgViewIface
TnyMsgWindow
TnyMsgWindowIface
TnyNoopLockable
TnyNoopLockableClass
TnyPair
TnyPairClass
TnyPasswordGetter
TnyPasswordGetterIface
TnyPlatformFactory
TnyPlatformFactoryIface
TnyQueue
TnyQueueIface
TnyQueueTask
TnyQueueTaskCallback
TnyQueueTaskFunc
TnyQueueTaskIface
TnySendQueue
TnySendQueueIface
TnySendQueueSignal
TnySessionCamel
TnySessionCamelClass
TnySessionCamelPriv
TnySimpleList
TnySimpleListClass
TnySimpleListIterator
TnySimpleListPriv
TnyStatus
TnyStatusCode
TnyStatusDomain
TnyStoreAccount
TnyStoreAccountIface
TnyStoreAccountSignal
TnyStream
TnyStreamCamel
TnyStreamIface
TnySummaryView
TnySummaryViewIface
TnySyncFolderCallback
TnyTpMailNotifier
TnyTransferMsgsCallback (cancelled)
TnyTransportAccount
TnyTransportAccountIface
TnyVfsStream
tny_debug
tny_folder_store_get_folders_async (status_callback)
tny_marshal_VOID__OBJECT_OBJECT_INT_INT
tny_marshal_VOID__OBJECT_OBJECT_POINTER


mozilla-preferences:Long_Description
mozilla-preferences:Short_Description
tny-async-worker-queue-priv:Long_Description
tny-async-worker-queue-priv:Short_Description
tny-async-worker-queue-task-priv:Short_Description
tny-camel-account-priv:Long_Description
tny-camel-account-priv:Short_Description
tny-camel-common-priv:Long_Description
tny-camel-common-priv:Short_Description
tny-camel-folder-priv:Long_Description
tny-camel-folder-priv:Short_Description
tny-camel-header-priv:Long_Description
tny-camel-header-priv:Short_Description
tny-camel-imap-folder-priv:Long_Description
tny-camel-imap-folder-priv:Short_Description
tny-camel-mem-stream:Long_Description
tny-camel-mem-stream:Short_Description
tny-camel-mime-part-priv:Long_Description
tny-camel-mime-part-priv:Short_Description
tny-camel-msg-header-priv:Long_Description
tny-camel-msg-header-priv:Short_Description
tny-camel-msg-priv:Long_Description
tny-camel-msg-priv:Short_Description
tny-camel-nntp-folder-priv:Long_Description
tny-camel-nntp-folder-priv:Short_Description
tny-camel-pop-folder-priv:Long_Description
tny-camel-pop-folder-priv:Short_Description
tny-camel-pop-remote-msg-remove-strategy:Long_Description
tny-camel-pop-remote-msg-remove-strategy:Short_Description
tny-camel-pop-store-account-priv:Long_Description
tny-camel-pop-store-account-priv:Short_Description
tny-camel-queue-priv:Long_Description
tny-camel-queue-priv:Short_Description
tny-camel-send-queue-priv:Long_Description
tny-camel-send-queue-priv:Short_Description
tny-camel-store-account-priv:Long_Description
tny-camel-store-account-priv:Short_Description
tny-camel-stream-priv:Long_Description
tny-camel-stream-priv:Short_Description
tny-camel-transport-account-priv:Long_Description
tny-camel-transport-account-priv:Short_Description
tny-common-priv:Long_Description
tny-common-priv:Short_Description
tny-error:Long_Description
tny-error:Short_Description
tny-generic-send-queue-priv:Long_Description
tny-generic-send-queue-priv:Short_Description
tny-get-msg-queue-priv:Long_Description
tny-get-msg-queue-priv:Short_Description
tny-gnome-device-priv:Long_Description
tny-gnome-device-priv:Short_Description
tny-gtk-account-list-model-iterator-priv:Long_Description
tny-gtk-account-list-model-iterator-priv:Short_Description
tny-gtk-attach-list-model-iterator-priv:Long_Description
tny-gtk-attach-list-model-iterator-priv:Short_Description
tny-gtk-attach-list-model-priv:Long_Description
tny-gtk-attach-list-model-priv:Short_Description
tny-gtk-folder-store-tree-model-iterator-priv:Long_Description
tny-gtk-folder-store-tree-model-iterator-priv:Short_Description
tny-gtk-header-list-iterator-priv:Long_Description
tny-gtk-header-list-iterator-priv:Short_Description
tny-session-camel-priv:Long_Description
tny-session-camel-priv:Short_Description
tny-shared:Long_Description
tny-signals-marshal:Long_Description
tny-signals-marshal:Short_Description
tny-simple-list-iterator-priv:Long_Description
tny-simple-list-iterator-priv:Short_Description
tny-simple-list-priv:Long_Description
tny-simple-list-priv:Short_Description
tny-tp-mail-notifier:Long_Description
tny-tp-mail-notifier:Short_Description


        gtkdoc-mkdb --module=libtinymail
--source-dir=../../../libtinymail --output-format=xml
--expand-content-files="" --main-sgml-file=libtinymail-docs.sgml
--source-dir=../../../libtinymailui
--source-dir=../../../libtinymailui-gtk
--source-dir=../../../libtinymailui-mozembed
--source-dir=../../../libtinymail-gnomevfs
--source-dir=../../../libtinymail-gnome-desktop
--source-dir=../../../libtinymail-camel
--source-dir=../../../libtinymail-queues
--source-dir=../../../libtinymail-asyncworker
--source-dir=../../../libtinymail-tp  --sgml-mode --output-format=xml
--ignore-files="`find ../../../libtinymail-camel/camel-lite/ -printf \"%
f \"`"
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:29
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:30
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:31
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:63
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:64
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:65
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:66
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:85
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:86
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:108
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:123
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail/tny-common.c:124
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail-camel/tny-camel-folder.c:856
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail-camel/tny-camel-folder.c:857
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail-camel/tny-camel-folder.c:858
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail-camel/tny-camel-common.c:38
ERROR parsing comment block file : parameter expected -
 ../../../libtinymail-camel/tny-camel-common.c:39
WARNING: Symbol name not found at the start of the comment block.
 ../../../libtinymail-camel/tny-camel-transport-account.c line 158
WARNING: Documentation in template file for
TnyAccount::connection-status-changed being overridden by inline
comments
WARNING: Parameter described in source code comment block but does not
exist -
         FUNCTION: tny_account_start_operation Parameter: mdomain.
WARNING: Parameter described in source code comment block but does not
exist -
         FUNCTION: tny_account_start_operation Parameter: mcode.
WARNING: Documentation in template file for TnySendQueue::msg-sent being
overridden by inline comments
WARNING: Documentation in template file for TnySendQueue::error-happened
being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::account-removed being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::accounts-reloaded being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::account-inserted being overridden by inline comments
WARNING: Documentation in template file for
TnyAccount::connection-status-changed being overridden by inline
comments
WARNING: Documentation in template file for
TnyDevice::connection-changed being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::connecting-finished being overridden by inline comments
WARNING: Documentation in template file for
TnyStoreAccount::subscription-changed being overridden by inline
comments
WARNING: Documentation in template file for
TnyAccountStore::account-changed being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::connecting-started being overridden by inline comments
Cannot parse structure field "#ifdef GNOME


WARNING: Documentation in template file for
TnyAccountStore::account-removed being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::accounts-reloaded being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::account-inserted being overridden by inline comments
WARNING: Documentation in template file for
TnyAccount::connection-status-changed being overridden by inline
comments
WARNING: Documentation in template file for
TnyDevice::connection-changed being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::connecting-finished being overridden by inline comments
WARNING: Documentation in template file for
TnyStoreAccount::subscription-changed being overridden by inline
comments
WARNING: Documentation in template file for
TnyAccountStore::account-changed being overridden by inline comments
WARNING: Documentation in template file for
TnyAccountStore::connecting-started being overridden by inline comments



        gboolean invnm" at /usr/share/gtk-doc/data/gtkdoc-common.pl line
225, <INPUT> line 1813.
Cannot parse structure field "#endif

}" at /usr/share/gtk-doc/data/gtkdoc-common.pl line 225, <INPUT> line
1813.
64% symbol docs coverage (576 symbols documented, 5 symbols incomplete,
319 not documented)
See libtinymail-undocumented.txt for a list of missing docs.
The doc coverage percentage doesn't include intro sections.
touch sgml-build.stamp
gtk-doc: Building HTML
rm -rf ./html 
mkdir ./html
cd ./html && gtkdoc-mkhtml libtinymail ../libtinymail-docs.sgml


-- 
Philip Van Hoof, software developer
home: me at pvanhoof dot be 
gnome: pvanhoof at gnome dot org 
http://www.pvanhoof.be/blog