docs: Move documentation to inline comments: GtkProgressBar

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=634339

Signed-off-by: Javier Jardón <jjardon@gnome.org>

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 5ac6dc17a58e82aacbbe8ef188d6a97ea8f91cb0..c1f7037e337e70d356c1ba1a1749bd6dbf3ef659 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -34,6 +34,7 @@ gtkpagesetup.sgml
 gtkpagesetupunixdialog.sgml
 gtkpapersize.sgml
 gtkprinter.sgml
+gtkprogressbar.sgml
 gtkradioaction.sgml
 gtkradiobutton.sgml
 gtkrange.sgml

diff --git a/docs/reference/gtk/tmpl/gtkprogressbar.sgml b/docs/reference/gtk/tmpl/gtkprogressbar.sgml
deleted file mode 100644 (file)
index 8d36f59..0000000
--- a/docs/reference/gtk/tmpl/gtkprogressbar.sgml
+++ /dev/null
@@ -1,241 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkProgressBar
-
-<!-- ##### SECTION Short_Description ##### -->
-A widget which indicates progress visually
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The #GtkProgressBar is typically used to display the progress of a long
-running operation.  It provides a visual clue that processing
-is underway.  The #GtkProgressBar can be used in two different
-modes: percentage mode and activity mode.
-</para>
-
-<para>
-When an application can determine how much work needs to take place 
-(e.g. read a fixed number of bytes from a file) and can monitor its
-progress, it can use the #GtkProgressBar in percentage mode and the user
-sees a growing bar indicating the percentage of the work that has
-been completed.  In this mode, the application is required to call
-gtk_progress_bar_set_fraction() periodically to update the progress bar.
-</para>
-
-<para>
-When an application has no accurate way of knowing the amount of work
-to do, it can use the #GtkProgressBar in activity mode, which shows activity 
-by a block moving back and forth within the progress area. In this mode,
-the application is required to call gtk_progress_bar_pulse() perodically
-to update the progress bar.
-</para>
-
-<para>
-There is quite a bit of flexibility provided to control the appearance
-of the #GtkProgressBar.  Functions are provided to control the 
-orientation of the bar, optional text can be displayed along with
-the bar, and the step size used in activity mode can be set.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkProgressBar ##### -->
-<para>
-The #GtkProgressBar-struct struct contains private data only, 
-and should be accessed using the functions below.
-</para>
-
-
-<!-- ##### ARG GtkProgressBar:ellipsize ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:fraction ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:inverted ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:pulse-step ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:show-text ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:text ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:min-horizontal-bar-height ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:min-horizontal-bar-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:min-vertical-bar-height ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:min-vertical-bar-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:xspacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkProgressBar:yspacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_progress_bar_new ##### -->
-<para>
-Creates a new #GtkProgressBar.
-</para>
-
-@void: 
-@Returns: a #GtkProgressBar.
-
-
-<!-- ##### FUNCTION gtk_progress_bar_pulse ##### -->
-<para>
-
-</para>
-
-@pbar: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_fraction ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@fraction: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_fraction ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_inverted ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@inverted: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_inverted ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_show_text ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@show_text: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_show_text ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_text ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@text: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_text ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_ellipsize ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@mode: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_ellipsize ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_set_pulse_step ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@fraction: 
-
-
-<!-- ##### FUNCTION gtk_progress_bar_get_pulse_step ##### -->
-<para>
-
-</para>
-
-@pbar: 
-@Returns: 
-
-

diff --git a/gtk/gtkprogressbar.c b/gtk/gtkprogressbar.c
index 1caac5df214a884a7c6dbd1146599168fe0ad683..9cca76b328cf4e1e5b5f79b1706fee43f9311d35 100644 (file)
--- a/gtk/gtkprogressbar.c
+++ b/gtk/gtkprogressbar.c
@@ -33,6 +33,34 @@
 #include "gtkprivate.h"
 #include "gtkintl.h"
 
+/**
+ * SECTION:gtkprogressbar
+ * @Short_description: A widget which indicates progress visually
+ * @Title: GtkProgressBar
+ *
+ * The #GtkProgressBar is typically used to display the progress of a long
+ * running operation.  It provides a visual clue that processing
+ * is underway.  The #GtkProgressBar can be used in two different
+ * modes: percentage mode and activity mode.
+ *
+ * When an application can determine how much work needs to take place
+ * (e.g. read a fixed number of bytes from a file) and can monitor its
+ * progress, it can use the #GtkProgressBar in percentage mode and the user
+ * sees a growing bar indicating the percentage of the work that has
+ * been completed.  In this mode, the application is required to call
+ * gtk_progress_bar_set_fraction() periodically to update the progress bar.
+ *
+ * When an application has no accurate way of knowing the amount of work
+ * to do, it can use the #GtkProgressBar in activity mode, which shows
+ * activity by a block moving back and forth within the progress area. In
+ * this mode, the application is required to call gtk_progress_bar_pulse()
+ * periodically to update the progress bar.
+ *
+ * There is quite a bit of flexibility provided to control the appearance
+ * of the #GtkProgressBar.  Functions are provided to control the
+ * orientation of the bar, optional text can be displayed along with
+ * the bar, and the step size used in activity mode can be set.
+ */
 
 #define MIN_HORIZONTAL_BAR_WIDTH   150
 #define MIN_HORIZONTAL_BAR_HEIGHT  20
@@ -356,6 +384,13 @@ gtk_progress_bar_get_property (GObject      *object,
     }
 }
 
+/**
+ * gtk_progress_bar_new:
+ *
+ * Creates a new #GtkProgressBar.
+ *
+ * Returns: a #GtkProgressBar.
+ */
 GtkWidget*
 gtk_progress_bar_new (void)
 {