examples: remove doxygen warning messages 24/156024/2
authorYoungbok Shin <youngb.shin@samsung.com>
Tue, 17 Oct 2017 04:02:43 +0000 (13:02 +0900)
committerGerrit Code Review <gerrit@review.ap-northeast-2.compute.internal>
Tue, 17 Oct 2017 05:08:56 +0000 (05:08 +0000)
It only remove warning messages which don't need example files.

Change-Id: Ia152012a0a197d7cc0472fefddeeccc090300f0f

doc/examples.dox

index 8850661..8c43e8b 100644 (file)
   *
   * Keeping any of those four buttons pressed will trigger their autorepeat
   * callback, where we move the button doing some size hint magic. To
-  * understand how that works better, refer to the @ref Box documentation.
+  * understand how that works better, refer to the @ref Elm_Box documentation.
   * Also, the first time the function is called, we change the icon in the
   * middle button, using elm_object_content_unset() first to keep the reference
   * to the previous one, so we don't need to recreate it when we are done
  * look like this picture:
  *
  * @image html screenshots/flipselector_example.png
- * @image latex screenshots/flipselector_example.eps width=\textwidth
+ * @image latex screenshots/flipselector_example.eps width=\\textwidth
  *
  * See the full @ref flipselector_example_c "source code" for this example.
  *
  * should look like this picture:
  *
  * @image html screenshots/fileselector_example.png
- * @image latex screenshots/fileselector_example.eps width=\textwidth
+ * @image latex screenshots/fileselector_example.eps width=\\textwidth
  *
  * See the full @ref fileselector_example_c "source code" for this example.
  *
  * This is how the example, just after called, should look like:
  *
  * @image html screenshots/fileselector_button_example_00.png
- * @image latex screenshots/fileselector_button_example_00.eps width=\textwidth
+ * @image latex screenshots/fileselector_button_example_00.eps width=\\textwidth
  *
  * Click on the file selector button to raise its internal file
  * selector, which will be contained on an <b>"inner window"</b>:
  *
  * @image html screenshots/fileselector_button_example_01.png
- * @image latex screenshots/fileselector_button_example_01.eps width=\textwidth
+ * @image latex screenshots/fileselector_button_example_01.eps width=\\textwidth
  *
  * Toggle the "inwin mode" switch off and, if you click on the file
  * selector button again, you'll get @b two windows, the original one
  * (note the last selection there!)
  *
  * @image html screenshots/fileselector_button_example_02.png
- * @image latex screenshots/fileselector_button_example_02.eps width=\textwidth
+ * @image latex screenshots/fileselector_button_example_02.eps width=\\textwidth
  *
  * and the file selector's new one
  *
  * @image html screenshots/fileselector_button_example_03.png
- * @image latex screenshots/fileselector_button_example_03.eps width=\textwidth
+ * @image latex screenshots/fileselector_button_example_03.eps width=\\textwidth
  *
  * Play with the checkboxes to get the behavior changes on the file
  * selector button. The respective API calls on the widget coming from
  * This is how the example, just after called, should look like:
  *
  * @image html screenshots/fileselector_entry_example_00.png
- * @image latex screenshots/fileselector_entry_example_00.eps width=\textwidth
+ * @image latex screenshots/fileselector_entry_example_00.eps width=\\textwidth
  *
  * Click on the file selector entry to raise its internal file
  * selector, which will be contained on an <b>"inner window"</b>:
  *
  * @image html screenshots/fileselector_entry_example_01.png
- * @image latex screenshots/fileselector_entry_example_01.eps width=\textwidth
+ * @image latex screenshots/fileselector_entry_example_01.eps width=\\textwidth
  *
  * Toggle the "inwin mode" switch off and, if you click on the file
  * selector entry again, you'll get @b two windows, the original one
  * (note the last selection there!)
  *
  * @image html screenshots/fileselector_entry_example_02.png
- * @image latex screenshots/fileselector_entry_example_02.eps width=\textwidth
+ * @image latex screenshots/fileselector_entry_example_02.eps width=\\textwidth
  *
  * and the file selector's new one
  *
  * @image html screenshots/fileselector_entry_example_03.png
- * @image latex screenshots/fileselector_entry_example_03.eps width=\textwidth
+ * @image latex screenshots/fileselector_entry_example_03.eps width=\\textwidth
  *
  * Play with the checkboxes to get the behavior changes on the file
  * selector entry. The respective API calls on the widget coming from
 /**
  * @page layout_example_01 Layout - Content, Table and Box
  *
- * This example shows how one can use the @ref Layout widget to create a
+ * This example shows how one can use the @ref Elm_Layout widget to create a
  * customized distribution of widgets on the screen, controlled by an Edje theme.
  * The full source code for this example can be found at @ref
  * layout_example_01_c.
  * of putting them in row, column, both, or any other available layout. This is
  * also described in the Edje documentation.
  *
- * This box area is similar to the @ref Box widget of elementary, with the
+ * This box area is similar to the @ref Elm_Box widget of elementary, with the
  * difference that its position and properties are controlled by the theme of the
  * layout. It also contains more than one API to add items to it, since the
  * items position now is defined in terms of a list of items, not a matrix.
  * A screenshot of this example can be seen on:
  *
  * @image html screenshots/layout_example_01.png
- * @image latex screenshots/layout_example_01.eps width=\textwidth
+ * @image latex screenshots/layout_example_01.eps width=\\textwidth
  *
  */
 
 /**
  * @page layout_example_02 Layout - Predefined Layout
  *
- * This example shows how one can use the @ref Layout with a predefined theme
+ * This example shows how one can use the @ref Elm_Layout with a predefined theme
  * layout to add a back and next button to a simple window. The full source code
  * for this example can be found at @ref layout_example_02_c.
  *
  * A screenshot of this example can be seen on:
  *
  * @image html screenshots/layout_example_02.png
- * @image latex screenshots/layout_example_02.eps width=\textwidth
+ * @image latex screenshots/layout_example_02.eps width=\\textwidth
  */
 
 /**
  * A screenshot of this example can be seen on:
  *
  * @image html screenshots/layout_example_03.png
- * @image latex screenshots/layout_example_03.eps width=\textwidth
+ * @image latex screenshots/layout_example_03.eps width=\\textwidth
  */
 
 /**
  * middle positions. In the middle position we are placing a button that when
  * clicked will hide the hover. We are also going to use a non-default theme
  * for our hover. We won't explain the functioning of button for that see @ref
- * Button.
+ * Elm_Button.
  *
  * We start our example with a couple of callbacks that show and hide the data
  * they're given(which we'll see later on is the hover widget):
  * Our example will initially look like this:
  *
  * @image html screenshots/hover_example_01.png
- * @image latex screenshots/hover_example_01.eps width=\textwidth
+ * @image latex screenshots/hover_example_01.eps width=\\textwidth
  *
  * And after you click the "Show hover" button it will look like this:
  *
  * @image html screenshots/hover_example_01_a.png
- * @image latex screenshots/hover_example_01_a.eps width=\textwidth
+ * @image latex screenshots/hover_example_01_a.eps width=\\textwidth
  *
  * @example hover_example_01.c
  */
   * green). Our example will allow the user to choose the animation the flip
   * uses and to interact with it. To allow the user to choose the interaction
   * mode we use radio buttons, we will however not explain them, if you would
-  * like to know more about radio buttons see @ref Radio.
+  * like to know more about radio buttons see @ref Elm_Radio.
   *
   * We start our example with the usual setup and then create the 2 rectangles
   * we will use in our flip:
   * Our example will look like this:
   *
   * @image html screenshots/flip_example_01.png
-  * @image latex screenshots/flip_example_01.eps width=\textwidth
+  * @image latex screenshots/flip_example_01.eps width=\\textwidth
   *
   * @note Since this is an animated example the screenshot doesn't do it
   * justice, it is a good idea to compile it and see the animations.
   * Our example will look like this:
   *
   * @image html screenshots/label_example_01.png
-  * @image latex screenshots/label_example_01.eps width=\textwidth
+  * @image latex screenshots/label_example_01.eps width=\\textwidth
   *
   * @example label_example_01.c
   */
   * This example will look like this:
   *
   * @image html screenshots/image_example_01.png
-  * @image latex screenshots/image_example_01.eps width=\textwidth
+  * @image latex screenshots/image_example_01.eps width=\\textwidth
   *
   * @example image_example_01.c
   */
   * This example will look like this:
   *
   * @image html screenshots/icon_example_01.png
-  * @image latex screenshots/icon_example_01.eps width=\textwidth
+  * @image latex screenshots/icon_example_01.eps width=\\textwidth
   *
   * @example icon_example_01.c
   */
  * Our example will initially look like this:
  *
  * @image html screenshots/hoversel_example_01.png
- * @image latex screenshots/hoversel_example_01.eps width=\textwidth
+ * @image latex screenshots/hoversel_example_01.eps width=\\textwidth
  *
  * And when the hoversel is clicked it will look like this:
  *
  * @image html screenshots/hoversel_example_01_a.png
- * @image latex screenshots/hoversel_example_01_a.eps width=\textwidth
+ * @image latex screenshots/hoversel_example_01_a.eps width=\\textwidth
  *
  * @example hoversel_example_01.c
  */
  * can see on the following image:
  *
  * @image html screenshots/conformant_example_01.png
- * @image latex screenshots/conformant_example_01.eps width=\textwidth
+ * @image latex screenshots/conformant_example_01.eps width=\\textwidth
  *
  * But if you call a virtual keyboard, the window will resize, changing
  * widgets size and position. All the content will shrink.
  * a window like the following:
  *
  * @image html screenshots/conformant_example_02.png
- * @image latex screenshots/conformant_example_02.eps width=\textwidth
+ * @image latex screenshots/conformant_example_02.eps width=\\textwidth
  *
  * As you can see, it guess the space that will be required by the keyboard,
  * indicator and softkey bars.
  * The example will initially look like this:
  *
  * @image html screenshots/ctxpopup_example_01.png
- * @image latex screenshots/ctxpopup_example_01.eps width=\textwidth
+ * @image latex screenshots/ctxpopup_example_01.eps width=\\textwidth
  *
  * @note This doesn't show the ctxpopup tough, since it will only appear when
  * we click one of the list items.
  * Here is what our first ctxpopup will look like:
  *
  * @image html screenshots/ctxpopup_example_01_a.png
- * @image latex screenshots/ctxpopup_example_01_a.eps width=\textwidth
+ * @image latex screenshots/ctxpopup_example_01_a.eps width=\\textwidth
  *
  * And here the second ctxpopup:
  *
  * @image html screenshots/ctxpopup_example_01_b.png
- * @image latex screenshots/ctxpopup_example_01_b.eps width=\textwidth
+ * @image latex screenshots/ctxpopup_example_01_b.eps width=\\textwidth
  *
  * @example ctxpopup_example_01.c
  */
  * This example will look like this:
  *
  * @image html screenshots/separator_example_01.png
- * @image latex screenshots/separator_example_01.eps width=\textwidth
+ * @image latex screenshots/separator_example_01.eps width=\\textwidth
  *
  * @example separator_example_01.c
  */
  * The example will look like this:
  *
  * @image html screenshots/radio_example_01.png
- * @image latex screenshots/radio_example_01.eps width=\textwidth
+ * @image latex screenshots/radio_example_01.eps width=\\textwidth
  *
  * @example radio_example_01.c
  */
  * This example will look like this;
  *
  * @image html screenshots/panel_example_01.png
- * @image latex screenshots/panel_example_01.eps width=\textwidth
+ * @image latex screenshots/panel_example_01.eps width=\\textwidth
  * @note The buttons with arrow allow the user to hide/show the panels.
  *
  * @example panel_example_01.c
  *
  * This is how the example program's window looks like:
  * @image html screenshots/gengrid_example.png
- * @image latex screenshots/gengrid_example.eps width=\textwidth
+ * @image latex screenshots/gengrid_example.eps width=\\textwidth
  *
  * Note that it starts with three items which we included at will:
  * @dontinclude gengrid_example.c
 /**
  * @page entry_example Entry - Example of simple editing
  *
- * As a general overview of @ref Entry we are going to write an, albeit simple,
+ * As a general overview of @ref Elm_Entry we are going to write an, albeit simple,
  * functional editor. Although intended to show how elm_entry works, this
  * example also makes extensive use of several other widgets. The full code
  * can be found in @ref entry_example.c "entry_example.c" and in the following
- * lines we'll go through the parts especific to the @ref Entry widget.
+ * lines we'll go through the parts especific to the @ref Elm_Entry widget.
  *
  * The program itself is a simple editor, with a file already set to it, that
  * can be set to autosave or not and allows insertion of emoticons and some
  * top of the window and returning focus back to the main entry afterwards.
  *
  * @image html screenshots/entry_example.png
- * @image latex screenshots/entry_example.eps width=\textwidth
+ * @image latex screenshots/entry_example.eps width=\\textwidth
  *
  * We'll begin by showing a few structures used throught the program. First,
  * the application owns data that holds the main window and the main entry
  * @skip static void
  * @until }
  *
- * One of the buttons on the top will trigger an @ref Inwin to open and show
+ * One of the buttons on the top will trigger an @ref Elm_Inwin to open and show
  * us several icons we can insert into the text. We'll jump over most of these
  * functions, but when all the options are chosen, we insert the special
  * markup text that will show the chosen icon in place.
  * just that, a box that holds text, and in order to have some frame around it
  * or a background color, another widget needs to provide this. When an entry
  * is scrollable, the same scroller used internally does this.
- * We are using @ref Frame "frames" here to provide some decoration around,
+ * We are using @ref Elm_Frame "frames" here to provide some decoration around,
  * then creating our entries, set them to single line, add our two filters and
  * the callback for when their value change.
  * @until _height_changed_cb
  * The current example will look like this when running:
  *
  * @image html screenshots/genlist_example_01.png
- * @image latex screenshots/genlist_example_01.eps width=\textwidth
+ * @image latex screenshots/genlist_example_01.eps width=\\textwidth
  */
 
 /**
  * The current example will look like this when running:
  *
  * @image html screenshots/genlist_example_02.png
- * @image latex screenshots/genlist_example_02.eps width=\textwidth
+ * @image latex screenshots/genlist_example_02.eps width=\\textwidth
  */
 
 /**
  * And the screenshot of the running example:
  *
  * @image html screenshots/genlist_example_03.png
- * @image latex screenshots/genlist_example_03.eps width=\textwidth
+ * @image latex screenshots/genlist_example_03.eps width=\\textwidth
  *
  * @example genlist_example_03.c
  */
  * The example will look like this when running:
  *
  * @image html screenshots/genlist_example_04.png
- * @image latex screenshots/genlist_example_04.eps width=\textwidth
+ * @image latex screenshots/genlist_example_04.eps width=\\textwidth
  */
 
 /**
  * @page genlist_example_05 Genlist - working with subitems
  *
- * This is probably the most complex example of elementary @ref Genlist. We
+ * This is probably the most complex example of elementary @ref Elm_Genlist. We
  * create a tree of items, using the subitems properties of the items, and keep
  * it in memory to be able to expand/hide subitems of an item. The full source
  * code can be found at @ref genlist_example_05_c
  * The example will look like this when running:
  *
  * @image html screenshots/genlist_example_05.png
- * @image latex screenshots/genlist_example_05.eps width=\textwidth
+ * @image latex screenshots/genlist_example_05.eps width=\\textwidth
  */
 
 /**
  * The example will look like this when running:
  *
  * @image html screenshots/thumb_example_01.png
- * @image latex screenshots/thumb_example_01.eps width=\textwidth
+ * @image latex screenshots/thumb_example_01.eps width=\\textwidth
  */
 
 /**
  *
  * This is how the example program's window looks like:
  * @image html screenshots/progressbar_example.png
- * @image latex screenshots/progressbar_example.eps width=\textwidth
+ * @image latex screenshots/progressbar_example.eps width=\\textwidth
  *
  * See the full @ref progressbar_example_c "source code" for
  * this example.
  * Our example will initially look like this:
  *
  * @image html screenshots/notify_example_01.png
- * @image latex screenshots/notify_example_01.eps width=\textwidth
+ * @image latex screenshots/notify_example_01.eps width=\\textwidth
  *
  * Once the first notify is hidden:
  *
  * @image html screenshots/notify_example_01_a.png
- * @image latex screenshots/notify_example_01_a.eps width=\textwidth
+ * @image latex screenshots/notify_example_01_a.eps width=\\textwidth
  *
  * @example notify_example_01.c
  */
  * This example will initially look like this:
  *
  * @image html screenshots/popup_example_01.png
- * @image latex screenshots/popup_example_01.eps width=\textwidth
+ * @image latex screenshots/popup_example_01.eps width=\\textwidth
  *
  * Once the popup is hidden after timeout:
  *
  * @image html screenshots/popup_example_01_a.png
- * @image latex screenshots/popup_example_01_a.eps width=\textwidth
+ * @image latex screenshots/popup_example_01_a.eps width=\\textwidth
  *
  * @example popup_example_01.c
  */
  * This example will look like this:
  *
  * @image html screenshots/popup_example_02.png
- * @image latex screenshots/popup_example_02.eps width=\textwidth
+ * @image latex screenshots/popup_example_02.eps width=\\textwidth
  *
  * @example popup_example_02.c
  */
  * This example will look like this:
  *
  * @image html screenshots/popup_example_03.png
- * @image latex screenshots/popup_example_03.eps width=\textwidth
+ * @image latex screenshots/popup_example_03.eps width=\\textwidth
  *
  * @example popup_example_03.c
  */
  * Our example will look like this:
  *
  * @image html screenshots/frame_example_01.png
- * @image latex screenshots/frame_example_01.eps width=\textwidth
+ * @image latex screenshots/frame_example_01.eps width=\\textwidth
  *
  * @example frame_example_01.c
  */
  * Our example will look like this:
  *
  * @image html screenshots/check_example_01.png
- * @image latex screenshots/check_example_01.eps width=\textwidth
+ * @image latex screenshots/check_example_01.eps width=\\textwidth
  *
  * @example check_example_01.c
  */
  * This example will look like this:
  *
  * @image html screenshots/colorselector_example_01.png
- * @image latex screenshots/colorselector_example_01.eps width=\textwidth
+ * @image latex screenshots/colorselector_example_01.eps width=\\textwidth
  *
  * @example colorselector_example_01.c
  */
  * @until evas_object_show
  *
  * Next, we define the <b>item class</b> for our slideshow
- * items. Slideshow images are going to be Elementary @ref Photo "photo"
+ * items. Slideshow images are going to be Elementary @ref Elm_Photo "photo"
  * widgets, here, as pointed by our @c get class
  * function. We'll let the Elementary infrastructure to delete those
  * objects for us, and, as there's no additional data attached to our
  *
  * This is how the example program's window looks like:
  * @image html screenshots/slideshow_example.png
- * @image latex screenshots/slideshow_example.eps width=\textwidth
+ * @image latex screenshots/slideshow_example.eps width=\\textwidth
  *
  * See the full @ref slideshow_example_c "source code" for
  * this example.
  * Our example will initially look like this:
  *
  * @image html screenshots/photocam_example_01.png
- * @image latex screenshots/photocam_example_01.eps width=\textwidth
+ * @image latex screenshots/photocam_example_01.eps width=\\textwidth
  *
  * @example photocam_example_01.c
  */
  * The program is nothing but a window with a lonely button, as shown here.
  *
  * @image html screenshots/inwin_example.png
- * @image latex screenshots/inwin_example.eps width=\textwidth
+ * @image latex screenshots/inwin_example.eps width=\\textwidth
  *
  * And pressing the button makes an inwin appear.
  *
  * @image html screenshots/inwin_example_a.png
- * @image latex screenshots/inwin_example_a.eps width=\textwidth
+ * @image latex screenshots/inwin_example_a.eps width=\\textwidth
  *
  * And the code is just as simple. We being with some global variables to keep
  * track of our Inwin.
  * it will work kind of like a modal window, blocking any other widget from
  * receiving events until the window is manually dismissed by pressing some
  * button to close it or having blocking task signalling its completion so
- * normal operations can be resumed. This is unlike the @ref Hover widget,
+ * normal operations can be resumed. This is unlike the @ref Elm_Hover widget,
  * that would show its content on top of the designated target, but clicking
  * anywhere else would dismiss it automatically.
  *
  * Our example will look like this:
  *
  * @image html screenshots/scroller_example_01.png
- * @image latex screenshots/scroller_example_01.eps width=\textwidth
+ * @image latex screenshots/scroller_example_01.eps width=\\textwidth
  *
  * @example scroller_example_01.c
  */
  * Our example will look like this:
  *
  * @image html screenshots/table_example_01.png
- * @image latex screenshots/table_example_01.eps width=\textwidth
+ * @image latex screenshots/table_example_01.eps width=\\textwidth
  *
  * @example table_example_01.c
  */
  * Our example will look like this:
  *
  * @image html screenshots/table_example_02.png
- * @image latex screenshots/table_example_02.eps width=\textwidth
+ * @image latex screenshots/table_example_02.eps width=\\textwidth
  *
  * @example table_example_02.c
  */
  * Our example will look like this:
  *
  * @image html screenshots/menu_example_01.png
- * @image latex screenshots/menu_example_01.eps width=\textwidth
+ * @image latex screenshots/menu_example_01.eps width=\\textwidth
  *
  * @example menu_example_01.c
  */
 /**
  * @page win_example_01 Win - General API overview
  *
- * For most users of the Elementary API, the @ref Win widget has a lot more
+ * For most users of the Elementary API, the @ref Elm_Win widget has a lot more
  * functions than what they need.
  *
  * In general, a developer will create a window, set some content on it and