Elm: update Doxyfile and remove doxygen documentation for deprecated widgets:

- anchorblock
- anchorview
- pager

Patch by Jérôme Pinot


SVN revision: 69849
This commit is contained in:
Vincent Torri 2012-04-02 06:28:10 +00:00
parent 7f2fc8ef80
commit c9d0fc793b
3 changed files with 2 additions and 115 deletions

View File

@ -41,7 +41,6 @@ VERBATIM_HEADERS = NO
SHOW_INCLUDE_FILES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
@ -132,9 +131,8 @@ GRAPHICAL_HIERARCHY = NO
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 512
MAX_DOT_GRAPH_HEIGHT = 512
DOT_GRAPH_MAX_NODES = 50
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
SEARCHENGINE = NO
LAYOUTFILE = DoxygenLayout.xml
LAYOUT_FILE = DoxygenLayout.xml

View File

@ -58,9 +58,6 @@ WGT_PREVIEW = \
flipselector:preview-00.png:widget_preview_flipselector:100:60 \
hoversel:preview-00.png:widget_preview_hoversel:90:170 \
hover:preview-00.png:widget_preview_hover:90:170 \
anchorview:preview-00.png:widget_preview_anchorview:100:30 \
anchorblock:preview-00.png:widget_preview_anchorblock:100:30 \
pager:preview-00.png:widget_preview_pager:100:100 \
separator:preview-00.png:widget_preview_separator:10:80 \
radio:preview-00.png:widget_preview_radio:60:20 \
panel:preview-00.png:widget_preview_panel:150:50 \

View File

@ -5333,114 +5333,6 @@
* @example frame_example_01.c
*/
/**
* @page tutorial_anchorblock_example Anchorblock/Anchorview example
* This example will show both Anchorblock and @ref Anchorview,
* since both are very similar and it's easier to show them once and side
* by side, so the difference is more clear.
*
* We'll show the relevant snippets of the code here, but the full example
* can be found here... sorry, @ref anchorblock_example_01.c "here".
*
* As for the actual example, it's just a simple window with an anchorblock
* and an anchorview, both containing the same text. After including
* Elementary.h and declaring some functions we'll need, we jump to our
* elm_main (see ELM_MAIN) and create our window.
* @dontinclude anchorblock_example_01.c
* @skip int
* @until const char
* @until ;
*
* With the needed variables declared, we'll create the window and a box to
* hold our widgets, but we don't need to go through that here.
*
* In order to make clear where the anchorblock ends and the anchorview
* begins, they'll be each inside a @ref Frame. After creating the frame,
* the anchorblock follows.
* @skip elm_frame_add
* @until elm_frame_content_set
*
* Nothing out of the ordinary there. What's worth mentioning is the call
* to elm_anchorblock_hover_parent_set(). We are telling our widget that
* when an anchor is clicked, the hover for the popup will cover the entire
* window. This affects the area that will be obscured by the hover and
* where clicking will dismiss it, as well as the calculations it does to
* inform the best locations where to insert the popups content.
* Other than that, the code is pretty standard. We also need to set our
* callback for when an anchor is clicked, since it's our task to populate
* the popup. There's no default for it.
*
* The anchorview is no different, we only change a few things so it looks
* different.
* @until elm_frame_content_set
*
* Then we run, so stuff works and close our main function in the usual way.
* @until ELM_MAIN
*
* Now, a little note. Normally you would use either one of anchorblock or
* anchorview, set your one callback to clicks and do your stuff in there.
* In this example, however, there are a few tricks to make it easier to
* show both widgets in one go (and to save me some typing). So we have
* two callbacks, one per widget, that will call a common function to do
* the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
* anchorview too, since both are equal, and passing a callback to use
* for our buttons to end the hover, because each widget has a different
* function for it.
* @until _anchorview_clicked_cb
* @until }
*
* The meat of our popup is in the following function. We check what kind
* of menu we need to show, based on the name set to the anchor in the
* markup text. If there's no type (something went wrong, no valid contact
* in the address list) we are just putting a button that does nothing, but
* it's perfectly reasonable to just end the hover and call it quits.
*
* Our popup will consist of one main button in the middle of our hover,
* and possibly a secondary button and a list of other options. We'll create
* first our main button and check what kind of popup we need afterwards.
* @skip static void
* @skip static void
* @until eina_stringshare_add
* @until }
*
* Each button has two callbacks, one is our hack to close the hover
* properly based on which widget it belongs to, the other a simple
* printf that will show the action with the anchors own data. This is
* not how you would usually do it. Instead, the common case is to have
* one callback for the button that will know which function to call to end
* things, but since we are doing it this way it's worth noting that
* smart callbacks will be called in reverse in respect to the order they
* were added, and since our @c btn_end_cb will close the hover, and thus
* delete our buttons, the other callback wouldn't be called if we had
* added it before.
*
* After our telephone popup, there are a few others that are practically
* the same, so they won't be shown here.
*
* Once we are done with that, it's time to place our actions into our
* hover. Main button goes in the middle without much questioning, and then
* we see if we have a secondary button and a box of extra options.
* Because I said so, secondary button goes on either side and box of
* options either on top or below the main one, but to choose which
* exactly, we use the hints our callback info has, which saves us from
* having to do the math and see which side has more space available, with
* a little special case where we delete our extra stuff if there's nowhere
* to place it.
* @skip url:
* @skip }
* @skip evas_object_smart
* @until evas_object_del(box)
* @until }
* @until }
*
* The example will look like this:
*
* @image html screenshots/anchorblock_01.png
* @image latex screenshots/anchorblock_01.eps width=\textwidth
*
* @example anchorblock_example_01.c
*/
/**
* @page tutorial_check Check example
* @dontinclude check_example_01.c