From 72e131f1d89da124620a00b22206fc6bb3822021 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Tue, 1 May 2012 13:48:00 +0100 Subject: [PATCH 14/15] Mark private headers as such in the header This means we don't have to remember to list them all in docs/reference/Makefile.am, which seems like a win. We still need to list proxy-introspectable.h, which is a bit of a special case. --- docs/reference/Makefile.am | 27 +------------------- telepathy-glib/account-channel-request-internal.h | 1 + telepathy-glib/account-internal.h | 1 + telepathy-glib/account-manager-internal.h | 1 + .../add-dispatch-operation-context-internal.h | 1 + telepathy-glib/automatic-client-factory-internal.h | 1 + telepathy-glib/base-call-internal.h | 1 + telepathy-glib/base-client-internal.h | 1 + telepathy-glib/base-connection-internal.h | 1 + telepathy-glib/base-contact-list-internal.h | 1 + telepathy-glib/base-protocol-internal.h | 1 + telepathy-glib/call-internal.h | 1 + telepathy-glib/capabilities-internal.h | 1 + .../channel-dispatch-operation-internal.h | 1 + telepathy-glib/channel-internal.h | 1 + telepathy-glib/client-factory-internal.h | 1 + telepathy-glib/client-message-internal.h | 1 + telepathy-glib/cm-message-internal.h | 1 + telepathy-glib/connection-internal.h | 1 + telepathy-glib/contact-internal.h | 1 + telepathy-glib/contact-list-channel-internal.h | 1 + telepathy-glib/contact-search-internal.h | 1 + telepathy-glib/dbus-internal.h | 1 + telepathy-glib/dbus-properties-mixin-internal.h | 1 + telepathy-glib/debug-internal.h | 2 ++ telepathy-glib/debug-message-internal.h | 1 + telepathy-glib/handle-channels-context-internal.h | 1 + telepathy-glib/handle-repo-internal.h | 1 + telepathy-glib/message-internal.h | 1 + telepathy-glib/observe-channels-context-internal.h | 1 + telepathy-glib/protocol-internal.h | 1 + telepathy-glib/proxy-internal.h | 1 + telepathy-glib/reentrants.h | 2 ++ telepathy-glib/room-info-internal.h | 1 + telepathy-glib/signalled-message-internal.h | 1 + telepathy-glib/stream-tube-connection-internal.h | 1 + telepathy-glib/util-internal.h | 1 + 37 files changed, 39 insertions(+), 26 deletions(-) diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 852ec58..4f7b9a9 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -62,33 +62,8 @@ EXTRA_HFILES= # Header files or dirs to ignore when scanning. Use base file/dir names # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code IGNORE_HFILES=\ - account-channel-request-internal.h \ - add-dispatch-operation-context-internal.h \ - automatic-client-factory-internal.h \ - base-call-internal.h \ - base-connection-internal.h \ - base-contact-list-internal.h \ - base-protocol-internal.h \ - call-internal.h \ - channel-dispatch-operation-internal.h \ - channel-internal.h \ - client-factory-internal.h \ - client-message-internal.h \ - cm-message-internal.h \ - connection-internal.h \ - contact-internal.h \ - contact-list-channel-internal.h \ - debug-internal.h \ - handle-channels-context-internal.h \ - handle-repo-internal.h \ - message-internal.h \ - observe-channels-context-internal.h \ - protocol-internal.h \ - proxy-internal.h \ proxy-introspectable.h \ - reentrants.h \ - signalled-message-internal.h \ - util-internal.h + $(NULL) # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/telepathy-glib/account-channel-request-internal.h b/telepathy-glib/account-channel-request-internal.h index 03f7033..644064f 100644 --- a/telepathy-glib/account-channel-request-internal.h +++ b/telepathy-glib/account-channel-request-internal.h @@ -1,3 +1,4 @@ +/**/ /* * object used to request a channel from a TpAccount (internal) * diff --git a/telepathy-glib/account-internal.h b/telepathy-glib/account-internal.h index 2fbf071..93eb2a3 100644 --- a/telepathy-glib/account-internal.h +++ b/telepathy-glib/account-internal.h @@ -1,3 +1,4 @@ +/**/ /* * TpAccount - proxy for a Telepathy account (internals) * diff --git a/telepathy-glib/account-manager-internal.h b/telepathy-glib/account-manager-internal.h index 4ac35c5..c05ef4a 100644 --- a/telepathy-glib/account-manager-internal.h +++ b/telepathy-glib/account-manager-internal.h @@ -1,3 +1,4 @@ +/**/ /* * TpAccountManager - proxy for a Telepathy account manager (internals) * diff --git a/telepathy-glib/add-dispatch-operation-context-internal.h b/telepathy-glib/add-dispatch-operation-context-internal.h index c07740f..0c56304 100644 --- a/telepathy-glib/add-dispatch-operation-context-internal.h +++ b/telepathy-glib/add-dispatch-operation-context-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Context objects for AddDispatchOperation calls (internal) * diff --git a/telepathy-glib/automatic-client-factory-internal.h b/telepathy-glib/automatic-client-factory-internal.h index 60fda5c..621f835 100644 --- a/telepathy-glib/automatic-client-factory-internal.h +++ b/telepathy-glib/automatic-client-factory-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Internal constructors for TpChannel subclasses * diff --git a/telepathy-glib/base-call-internal.h b/telepathy-glib/base-call-internal.h index 3fbbeac..1f32a6b 100644 --- a/telepathy-glib/base-call-internal.h +++ b/telepathy-glib/base-call-internal.h @@ -1,3 +1,4 @@ +/**/ /* * base-call-internal.h - Header for TpBaseCall* (internals) * Copyright © 2011 Collabora Ltd. diff --git a/telepathy-glib/base-client-internal.h b/telepathy-glib/base-client-internal.h index 776e3a7..4707049 100644 --- a/telepathy-glib/base-client-internal.h +++ b/telepathy-glib/base-client-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Base class for Client implementations * diff --git a/telepathy-glib/base-connection-internal.h b/telepathy-glib/base-connection-internal.h index 5cc8804..cd731d4 100644 --- a/telepathy-glib/base-connection-internal.h +++ b/telepathy-glib/base-connection-internal.h @@ -1,3 +1,4 @@ +/**/ /* Base class for Connection implementations * * Copyright © 2007-2010 Collabora Ltd. diff --git a/telepathy-glib/base-contact-list-internal.h b/telepathy-glib/base-contact-list-internal.h index f97cf47..7a17946 100644 --- a/telepathy-glib/base-contact-list-internal.h +++ b/telepathy-glib/base-contact-list-internal.h @@ -1,3 +1,4 @@ +/**/ /* ContactList channel manager - internals * * Copyright © 2010 Collabora Ltd. diff --git a/telepathy-glib/base-protocol-internal.h b/telepathy-glib/base-protocol-internal.h index 555f502..498debb 100644 --- a/telepathy-glib/base-protocol-internal.h +++ b/telepathy-glib/base-protocol-internal.h @@ -1,3 +1,4 @@ +/**/ /* TpBaseProtocol (not public API) * * Copyright © 2007-2010 Collabora Ltd. diff --git a/telepathy-glib/call-internal.h b/telepathy-glib/call-internal.h index 4d0952e..e098674 100644 --- a/telepathy-glib/call-internal.h +++ b/telepathy-glib/call-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Internals for TpCallChannel, TpCallContent and TpCallStream * diff --git a/telepathy-glib/capabilities-internal.h b/telepathy-glib/capabilities-internal.h index 08609e5..10dd0fe 100644 --- a/telepathy-glib/capabilities-internal.h +++ b/telepathy-glib/capabilities-internal.h @@ -1,3 +1,4 @@ +/**/ /* Object representing the capabilities a Connection or a Contact * supports (internals). * diff --git a/telepathy-glib/channel-dispatch-operation-internal.h b/telepathy-glib/channel-dispatch-operation-internal.h index 9db1607..f04b7fb 100644 --- a/telepathy-glib/channel-dispatch-operation-internal.h +++ b/telepathy-glib/channel-dispatch-operation-internal.h @@ -1,3 +1,4 @@ +/**/ /* * channel-dispatch-operation-internal.h - proxy for channels awaiting approval * diff --git a/telepathy-glib/channel-internal.h b/telepathy-glib/channel-internal.h index 73e8c7c..e64467d 100644 --- a/telepathy-glib/channel-internal.h +++ b/telepathy-glib/channel-internal.h @@ -1,3 +1,4 @@ +/**/ /* * TpChannel - proxy for a Telepathy channel (internals) * diff --git a/telepathy-glib/client-factory-internal.h b/telepathy-glib/client-factory-internal.h index 8c529d6..c2ac274 100644 --- a/telepathy-glib/client-factory-internal.h +++ b/telepathy-glib/client-factory-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Internal methods of TpClientFactory * diff --git a/telepathy-glib/client-message-internal.h b/telepathy-glib/client-message-internal.h index a0753fa..c4482c5 100644 --- a/telepathy-glib/client-message-internal.h +++ b/telepathy-glib/client-message-internal.h @@ -1,3 +1,4 @@ +/**/ /* * client-message-internal.h - Header for TpClientMessage (internal) * Copyright (C) 2006-2010 Collabora Ltd. diff --git a/telepathy-glib/cm-message-internal.h b/telepathy-glib/cm-message-internal.h index bcd1125..5c13da6 100644 --- a/telepathy-glib/cm-message-internal.h +++ b/telepathy-glib/cm-message-internal.h @@ -1,3 +1,4 @@ +/**/ /* * message-internal.h - Header for TpCMMessage (internal * Copyright (C) 2006-2010 Collabora Ltd. diff --git a/telepathy-glib/connection-internal.h b/telepathy-glib/connection-internal.h index 715ad55..fcba281 100644 --- a/telepathy-glib/connection-internal.h +++ b/telepathy-glib/connection-internal.h @@ -1,3 +1,4 @@ +/**/ /* * TpConnection - proxy for a Telepathy connection (internals) * diff --git a/telepathy-glib/contact-internal.h b/telepathy-glib/contact-internal.h index ace2fb5..e77b52c 100644 --- a/telepathy-glib/contact-internal.h +++ b/telepathy-glib/contact-internal.h @@ -1,3 +1,4 @@ +/**/ /* Object representing a Telepathy contact (internal) * * Copyright © 2011 Collabora Ltd. diff --git a/telepathy-glib/contact-list-channel-internal.h b/telepathy-glib/contact-list-channel-internal.h index 21acb63..a1f1fa1 100644 --- a/telepathy-glib/contact-list-channel-internal.h +++ b/telepathy-glib/contact-list-channel-internal.h @@ -1,3 +1,4 @@ +/**/ /* A ContactList channel with handle type LIST or GROUP. * * Copyright © 2009-2010 Collabora Ltd. diff --git a/telepathy-glib/contact-search-internal.h b/telepathy-glib/contact-search-internal.h index a5d6766..d549900 100644 --- a/telepathy-glib/contact-search-internal.h +++ b/telepathy-glib/contact-search-internal.h @@ -1,3 +1,4 @@ +/**/ /* * contact-search-internal.h - private functions for contact searches * diff --git a/telepathy-glib/dbus-internal.h b/telepathy-glib/dbus-internal.h index ec0378b..48cb349 100644 --- a/telepathy-glib/dbus-internal.h +++ b/telepathy-glib/dbus-internal.h @@ -1,3 +1,4 @@ +/**/ /* * internal-dbus-glib.h - private header for dbus-glib glue * diff --git a/telepathy-glib/dbus-properties-mixin-internal.h b/telepathy-glib/dbus-properties-mixin-internal.h index ee60c0e..2c9fab1 100644 --- a/telepathy-glib/dbus-properties-mixin-internal.h +++ b/telepathy-glib/dbus-properties-mixin-internal.h @@ -1,3 +1,4 @@ +/**/ /* * dbus-properties-mixin-internal.h - D-Bus core Properties * Copyright © 2008-2012 Collabora Ltd. diff --git a/telepathy-glib/debug-internal.h b/telepathy-glib/debug-internal.h index 9ceb912..cea13da 100644 --- a/telepathy-glib/debug-internal.h +++ b/telepathy-glib/debug-internal.h @@ -1,3 +1,5 @@ +/**/ + #ifndef __DEBUG_H__ #define __DEBUG_H__ diff --git a/telepathy-glib/debug-message-internal.h b/telepathy-glib/debug-message-internal.h index 56039d7..df00510 100644 --- a/telepathy-glib/debug-message-internal.h +++ b/telepathy-glib/debug-message-internal.h @@ -1,3 +1,4 @@ +/**/ /* * debug-message-internal.h * diff --git a/telepathy-glib/handle-channels-context-internal.h b/telepathy-glib/handle-channels-context-internal.h index f440c4e..ac0e85a 100644 --- a/telepathy-glib/handle-channels-context-internal.h +++ b/telepathy-glib/handle-channels-context-internal.h @@ -1,3 +1,4 @@ +/**/ /* * object for HandleChannels calls context (internal) * diff --git a/telepathy-glib/handle-repo-internal.h b/telepathy-glib/handle-repo-internal.h index 200bb83..722f59c 100644 --- a/telepathy-glib/handle-repo-internal.h +++ b/telepathy-glib/handle-repo-internal.h @@ -1,3 +1,4 @@ +/**/ /* * internal-handle-repo.h - private header for handle repositories * diff --git a/telepathy-glib/message-internal.h b/telepathy-glib/message-internal.h index b62cb3b..69ae311 100644 --- a/telepathy-glib/message-internal.h +++ b/telepathy-glib/message-internal.h @@ -1,3 +1,4 @@ +/**/ /* * message-internal.h - Header for TpMessage (internal * Copyright (C) 2006-2010 Collabora Ltd. diff --git a/telepathy-glib/observe-channels-context-internal.h b/telepathy-glib/observe-channels-context-internal.h index 992724f..de496f1 100644 --- a/telepathy-glib/observe-channels-context-internal.h +++ b/telepathy-glib/observe-channels-context-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Context objects for TpBaseClient calls (internal) * diff --git a/telepathy-glib/protocol-internal.h b/telepathy-glib/protocol-internal.h index a1e7aaf..d53c61f 100644 --- a/telepathy-glib/protocol-internal.h +++ b/telepathy-glib/protocol-internal.h @@ -1,3 +1,4 @@ +/**/ /* TpProtocol - internal header * * Copyright © 2010 Collabora Ltd. diff --git a/telepathy-glib/proxy-internal.h b/telepathy-glib/proxy-internal.h index 735b21f..7acb97a 100644 --- a/telepathy-glib/proxy-internal.h +++ b/telepathy-glib/proxy-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Copyright (C) 2007-2008 Collabora Ltd. * Copyright (C) 2007-2008 Nokia Corporation diff --git a/telepathy-glib/reentrants.h b/telepathy-glib/reentrants.h index 662a2b5..e1ff718 100644 --- a/telepathy-glib/reentrants.h +++ b/telepathy-glib/reentrants.h @@ -1,3 +1,5 @@ +/**/ + #include #include diff --git a/telepathy-glib/room-info-internal.h b/telepathy-glib/room-info-internal.h index 454e0e0..00cc1f7 100644 --- a/telepathy-glib/room-info-internal.h +++ b/telepathy-glib/room-info-internal.h @@ -1,3 +1,4 @@ +/**/ /* * room-info-internal.h * diff --git a/telepathy-glib/signalled-message-internal.h b/telepathy-glib/signalled-message-internal.h index 090f4d5..0063ad9 100644 --- a/telepathy-glib/signalled-message-internal.h +++ b/telepathy-glib/signalled-message-internal.h @@ -1,3 +1,4 @@ +/**/ /* * signalled-message-internal.h - Header for TpSignalledMessage (internal) * Copyright (C) 2006-2010 Collabora Ltd. diff --git a/telepathy-glib/stream-tube-connection-internal.h b/telepathy-glib/stream-tube-connection-internal.h index 64c42a5..6ef6b62 100644 --- a/telepathy-glib/stream-tube-connection-internal.h +++ b/telepathy-glib/stream-tube-connection-internal.h @@ -1,3 +1,4 @@ +/**/ /* * Object representing a connection on a Stream Tube (internal) * diff --git a/telepathy-glib/util-internal.h b/telepathy-glib/util-internal.h index 9cd86ac..a841b1f 100644 --- a/telepathy-glib/util-internal.h +++ b/telepathy-glib/util-internal.h @@ -1,3 +1,4 @@ +/**/ /* * util-internal.h - Headers for non-public telepathy-glib utility functions * -- 1.7.10