From 80464a35319fc5f153be284886f669919b7a7596 Mon Sep 17 00:00:00 2001 From: Perry Werneck Date: Thu, 14 Feb 2019 05:58:35 -0200 Subject: [PATCH] Adding some documentation for testing gtk-doc. --- .gitignore | 1 + autogen.sh | 2 ++ configure.ac | 37 ++++++++++--------------------------- src/filetransfer/activity.c | 33 +++++++++++++++++++++++++++++++++ src/include/v3270/filetransfer.h | 24 ++++++++++++------------ v3270.cbp | 6 ++++-- 6 files changed, 62 insertions(+), 41 deletions(-) diff --git a/.gitignore b/.gitignore index b2cbd36..2f163cd 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ .tmp .obj .pot +m4 *~ *.log *.status diff --git a/autogen.sh b/autogen.sh index dc2863e..0de9751 100755 --- a/autogen.sh +++ b/autogen.sh @@ -6,6 +6,8 @@ test -n "$srcdir" || srcdir=. olddir=`pwd` cd "$srcdir" +mkdir -p m4 + aclocal if test $? != 0 ; then echo "aclocal failed." diff --git a/configure.ac b/configure.ac index 2d9860b..3265439 100644 --- a/configure.ac +++ b/configure.ac @@ -36,6 +36,9 @@ AC_INIT([libv3270], [5.2], [perry.werneck@gmail.com]) dnl Place auxilliary scripts here. AC_CONFIG_AUX_DIR([scripts]) +dnl Recommended for gtk-doc (https://developer.gnome.org/gtk-doc-manual/stable/settingup_autoconf.html.en) +AC_CONFIG_MACRO_DIR(m4) + dnl Compute the canonical host-system type AC_CANONICAL_HOST @@ -234,36 +237,16 @@ AC_SUBST(GLIB_LIBS) AC_SUBST(GLIB_CFLAGS) dnl --------------------------------------------------------------------------- -dnl Check for doxygen +dnl Check for GTK DOC dnl --------------------------------------------------------------------------- -AC_PATH_TOOL([DOXYGEN], [doxygen]) - -dnl Help line for graphviz (optionally used by doxygen) -AC_ARG_ENABLE(graphviz, - AS_HELP_STRING([--disable-graphviz], [prevent doxygen from using dot]), - [wantgraphviz=$enableval], [wantgraphviz=yes]) - -AC_CHECK_PROGS([GRAPHVIZDOT], [dot]) -AC_MSG_CHECKING([whether doxygen should use graphviz]) -if test "x$wantgraphviz" = "xyes" ; then - if test $GRAPHVIZDOT ; then - AC_MSG_RESULT([yes]) - usegraphviz=yes - else - AC_MSG_RESULT([no, graphviz missing]) - usegraphviz=no - fi -else - AC_MSG_RESULT([no, disabled by configure]) - usegraphviz=no -fi - -AC_SUBST(HAVE_DOT,`echo $usegraphviz | tr yesno YESNO`) +dnl https://developer.gnome.org/gtk-doc-manual/stable/settingup_autoconf.html.en -if test "x$DOXYGEN" != "x"; then - AC_CONFIG_FILES(doxygen/doxyfile) -fi +m4_ifdef([GTK_DOC_CHECK], [ +GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) +],[ +AM_CONDITIONAL([ENABLE_GTK_DOC], false) +]) dnl --------------------------------------------------------------------------- dnl Check for pic diff --git a/src/filetransfer/activity.c b/src/filetransfer/activity.c index 2ae52ef..8bd5d41 100644 --- a/src/filetransfer/activity.c +++ b/src/filetransfer/activity.c @@ -27,6 +27,16 @@ * */ +/** + * SECTION:V3270FTActivity + * @Short_description: A file transfer activity. + * @Title: V3270FTActivity + * + * The #V3270FTActivity object represents a single file transfer operation + * and contens the file names and the settings used for transfer. + * + */ + #include #include #include "private.h" @@ -143,17 +153,40 @@ widget->values[LIB3270_FT_VALUE_DFT] = 4096; } + /** + * v3270_ft_activity_new: + * + * Creates an empty file transfer activity. + * + * Returns: a new #V3270FTActivity. + */ LIB3270_EXPORT GObject * v3270_ft_activity_new() { return g_object_new(G_TYPE_V3270_FT_ACTIVITY, NULL); } + /** + * v3270_ft_activity_get_local_filename: + * @object: a #V3270FTActivity + * + * Get the full path of the local file. + * + * Returns: the local file path. + */ LIB3270_EXPORT const gchar * v3270_ft_activity_get_local_filename(const GObject *object) { const gchar *ptr = G_V3270_FT_ACTIVITY(object)->file.local; return (ptr ? ptr : ""); } + /** + * v3270_ft_activity_get_remote_filename: + * @object: a #V3270FTActivity + * + * Get the host file name. + * + * Returns: the host file name. + */ LIB3270_EXPORT const gchar * v3270_ft_activity_get_remote_filename(const GObject *object) { const gchar *ptr = G_V3270_FT_ACTIVITY(object)->file.remote; diff --git a/src/include/v3270/filetransfer.h b/src/include/v3270/filetransfer.h index cb687cf..9322e38 100644 --- a/src/include/v3270/filetransfer.h +++ b/src/include/v3270/filetransfer.h @@ -105,7 +105,7 @@ LIB3270_EXPORT void v3270_ft_settings_set_options(GtkWidget *widget, LIB3270_FT_OPTION options); LIB3270_EXPORT gboolean v3270_ft_settings_equals(GtkWidget *widget, GObject *activity); - // FT Activity widget + // FT Activity object #define G_TYPE_V3270_FT_ACTIVITY (V3270FTActivity_get_type ()) #define G_V3270_FT_ACTIVITY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_V3270_FT_ACTIVITY, V3270FTActivity)) #define G_V3270_FT_ACTIVITY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), G_TYPE_V3270_FT_ACTIVITY, V3270FTActivityClass)) @@ -116,20 +116,20 @@ typedef struct _V3270FTActivity V3270FTActivity; typedef struct _V3270FTActivityClass V3270FTActivityClass; - LIB3270_EXPORT GObject * v3270_ft_activity_new(); + LIB3270_EXPORT GObject * v3270_ft_activity_new(); - LIB3270_EXPORT void v3270_ft_activity_set_from_context(GObject * activity, GMarkupParseContext * context); + LIB3270_EXPORT void v3270_ft_activity_set_from_context(GObject * activity, GMarkupParseContext * context); - LIB3270_EXPORT const gchar * v3270_ft_activity_get_local_filename(const GObject *object); - LIB3270_EXPORT const gchar * v3270_ft_activity_get_remote_filename(const GObject *object); - LIB3270_EXPORT LIB3270_FT_OPTION v3270_ft_activity_get_options(const GObject *object); - LIB3270_EXPORT guint v3270_ft_activity_get_value(const GObject * object, LIB3270_FT_VALUE id); + LIB3270_EXPORT const gchar * v3270_ft_activity_get_local_filename(const GObject *object); + LIB3270_EXPORT const gchar * v3270_ft_activity_get_remote_filename(const GObject *object); + LIB3270_EXPORT LIB3270_FT_OPTION v3270_ft_activity_get_options(const GObject *object); + LIB3270_EXPORT guint v3270_ft_activity_get_value(const GObject * object, LIB3270_FT_VALUE id); - LIB3270_EXPORT void v3270_ft_activity_set_local_filename(GObject *object, const gchar *filename); - LIB3270_EXPORT void v3270_ft_activity_set_remote_filename(GObject *object, const gchar *filename); - LIB3270_EXPORT void v3270_ft_activity_set_options(GObject * object, LIB3270_FT_OPTION options); - LIB3270_EXPORT void v3270_ft_activity_set_value(GObject * object, LIB3270_FT_VALUE id, guint value); - LIB3270_EXPORT H3270FT * v3270_ft_activity_begin_transfer(GObject * object, H3270 *hSession, const char **message); + LIB3270_EXPORT void v3270_ft_activity_set_local_filename(GObject *object, const gchar *filename); + LIB3270_EXPORT void v3270_ft_activity_set_remote_filename(GObject *object, const gchar *filename); + LIB3270_EXPORT void v3270_ft_activity_set_options(GObject * object, LIB3270_FT_OPTION options); + LIB3270_EXPORT void v3270_ft_activity_set_value(GObject * object, LIB3270_FT_VALUE id, guint value); + LIB3270_EXPORT H3270FT * v3270_ft_activity_begin_transfer(GObject * object, H3270 *hSession, const char **message); // FT Dialog widget #define GTK_TYPE_V3270_FT_DIALOG (V3270FTDialog_get_type ()) diff --git a/v3270.cbp b/v3270.cbp index ab02518..9acd65b 100644 --- a/v3270.cbp +++ b/v3270.cbp @@ -42,6 +42,7 @@ + @@ -185,7 +186,9 @@ - + + @@ -196,7 +199,6 @@ - -- libgit2 0.21.2