Pending documentation improvement tasks:

For all files listed below, somebody with experience in that file should:

• Add his name after the file (For example @segfaultxavi), so that it is clear who is working on that.
• Explain the PURPOSE of that class: Why is it needed?
• Explain how it is USED: First some text (for example: “Instantiate the list widget and add items to it.”) and then some code (only a bit of code with the important parts, not a full program).
• Indicate special PRECAUTIONS when using this class: These are things that the user of the class has to be careful with.
• A good example is the Efl.Ui.Box class
• When the above RAW INFORMATION has been added, the author adds DONE after his name, and then @segfaultxavi will start converting it into a nicely written and formatted text (adding his name after the DONE tag).

Empty documentation:

Things like [[]] or [[ ]] are unacceptable.

• src/lib/elementary/efl_ui_tab_bar.eo @segfaultxavi
• src/lib/ecore/efl_loop_message_future_handler.eo (@eagleeye )
• src/lib/ecore/efl_loop_message_future.eo (@eagleeye)
• src/lib/ecore/ecore_event_message_handler.eo (@eagleeye)

C-style code references

Things like efl_file_set() make no sense for some bindings. They should be replaced with @Efl.File.

Single-line class descriptions:

Half the EO classes have a single-line description. This is OK for parameters or return values but not for classes.

Stable

Beta

• src/lib/ecore/efl_loop_message_future.eo (@eagleeye)
• src/lib/ecore/efl_loop_message_future_handler.eo (@eagleeye)
• src/lib/efl/interfaces/efl_config.eo
• src/lib/efl/interfaces/efl_control.eo
• src/lib/efl/interfaces/efl_gfx_buffer.eo
• src/lib/efl/interfaces/efl_gfx_fill.eo
• src/lib/efl/interfaces/efl_gfx_frame_controller.eo
• src/lib/efl/interfaces/efl_gfx_gradient.eo
• src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
• src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
• src/lib/efl/interfaces/efl_gfx_image_load_controller.eo
• src/lib/efl/interfaces/efl_gfx_path.eo
• src/lib/efl/interfaces/efl_gfx_shape.eo
• src/lib/efl/interfaces/efl_gfx_size_class.eo
• src/lib/efl/interfaces/efl_gfx_text_class.eo
• src/lib/efl/interfaces/efl_gfx_view.eo
• src/lib/efl/interfaces/efl_model.eo
• src/lib/efl/interfaces/efl_observable.eo
• src/lib/efl/interfaces/efl_observer.eo
• src/lib/efl/interfaces/efl_playable.eo
• src/lib/efl/interfaces/efl_player.eo
• src/lib/efl/interfaces/efl_ui_container_selectable.eo
• src/lib/efl/interfaces/efl_ui_draggable.eo
• src/lib/efl/interfaces/efl_ui_i18n.eo
• src/lib/efl/interfaces/efl_ui_menu.eo
• src/lib/efl/interfaces/efl_ui_text_selectable.eo
• src/lib/efl/interfaces/efl_ui_view.eo
• src/lib/efl/interfaces/efl_ui_view_factory.eo
• src/lib/efl/interfaces/efl_ui_zoom.eo
• src/lib/eio/efl_io_manager.eo (@segfaultxavi )
• src/lib/eio/efl_io_model.eo (@segfaultxavi )
• src/lib/elementary/efl_access_action.eo
• src/lib/elementary/efl_access_component.eo
• src/lib/elementary/efl_access_editable_text.eo
• src/lib/elementary/efl_access_object.eo
• src/lib/elementary/efl_access_selection.eo
• src/lib/elementary/efl_access_text.eo
• src/lib/elementary/efl_access_value.eo
• src/lib/elementary/efl_access_widget_action.eo
• src/lib/elementary/efl_access_window.eo
• src/lib/elementary/efl_datetime_manager.eo
• src/lib/elementary/efl_ui_button_legacy_part.eo
• src/lib/elementary/efl_ui_calendar_item.eo
• src/lib/elementary/efl_ui_check_legacy_part.eo
• src/lib/elementary/efl_ui_clock.eo
• src/lib/elementary/efl_ui_clock_legacy.eo
• src/lib/elementary/efl_ui_flip.eo
• src/lib/elementary/efl_ui_flip_part.eo
• src/lib/elementary/efl_ui_image_factory.eo
• src/lib/elementary/efl_ui_image_zoomable_pan.eo
• src/lib/elementary/efl_ui_layout_factory.eo
• src/lib/elementary/efl_ui_layout_part_bg.eo
• src/lib/elementary/efl_ui_layout_part_content.eo
• src/lib/elementary/efl_ui_layout_part.eo
• src/lib/elementary/efl_ui_list_view_pan.eo
• src/lib/elementary/efl_ui_navigation_bar_part_back_button.eo
• src/lib/elementary/efl_ui_navigation_bar_part.eo
• src/lib/elementary/efl_ui_panes_part.eo
• src/lib/elementary/efl_ui_progressbar_legacy_part.eo
• src/lib/elementary/efl_ui_progressbar_part.eo
• src/lib/elementary/efl_ui_radio_legacy_part.eo
• src/lib/elementary/efl_ui_selection.eo
• src/lib/elementary/efl_ui_state_model.eo
• src/lib/elementary/efl_ui_tab_bar.eo @segfaultxavi
• src/lib/elementary/efl_ui_tab_bar_default_item.eo @segfaultxavi
• src/lib/elementary/efl_ui_tab_page.eo @segfaultxavi
• src/lib/elementary/efl_ui_tab_pager.eo @segfaultxavi
• src/lib/elementary/efl_ui_text_editable.eo
• src/lib/elementary/efl_ui_text_part.eo
• src/lib/elementary/efl_ui_textpath.eo
• src/lib/elementary/efl_ui_textpath_part.eo
• src/lib/elementary/efl_ui_theme.eo
• src/lib/elementary/efl_ui_video.eo
• src/lib/elementary/efl_ui_win_part.eo
• src/lib/elementary/efl_ui_animation_view.eo (Needs proofreading)
• src/lib/emotion/efl_canvas_video.eo
• src/lib/evas/canvas/efl_canvas_animation_player.eo
• src/lib/evas/canvas/efl_canvas_filter_internal.eo
• src/lib/evas/canvas/efl_canvas_polygon.eo
• src/lib/evas/canvas/efl_canvas_rectangle.eo
• src/lib/evas/canvas/efl_canvas_scene3d.eo
• src/lib/evas/canvas/efl_canvas_surface_tbm.eo
• src/lib/evas/canvas/efl_canvas_surface_wayland.eo
• src/lib/evas/canvas/efl_canvas_surface_x11.eo
• src/lib/evas/canvas/efl_canvas_vg_container.eo
• src/lib/evas/canvas/efl_canvas_vg_gradient.eo
• src/lib/evas/canvas/efl_canvas_vg_gradient_linear.eo
• src/lib/evas/canvas/efl_canvas_vg_gradient_radial.eo
• src/lib/evas/canvas/efl_canvas_vg_image.eo
• src/lib/evas/canvas/efl_canvas_vg_node.eo
• src/lib/evas/canvas/efl_canvas_vg_shape.eo
• src/lib/evas/canvas/efl_canvas_text.eo (Broken English)
• src/lib/evas/canvas/efl_input_clickable.eo
• src/lib/evas/canvas/efl_text_cursor.eo (Comments from D10542)

Need more detail:

• src/lib/ecore/efl_loop_message_future_handler.eo (@eagleeye)
• src/lib/elementary/efl_ui_*_factory.eo (@felipealmeida)

Formatting problems:

Other tasks:

• T7702 Remove internally generated classes from EFL# doc
• References to EO types (Like Efl.Ui.Widget) without using @.

Already done:

• check out efl.ui.layout theme docs
• verify doc refs for efl.gfx.image.load_error in load_error get methods
• verify doc refs for efl.ui.theme.apply_error in efl_ui_layout_base and efl_ui_widget
• src/lib/elementary/efl_ui_grid_default_item.eo @bu5hm4n DONE @segfaultxavi
• efl_file.h
• efl_ui_win.eo: clearly separate exit_on_close and exit_on_windows_close (this is a class method).
• Anything containing common misspellings like setted, splitted, etc...
• src/lib/efl/interfaces/efl_ui_range_display.eo @segfaultxavi
• src/lib/elementary/efl_ui_popup_part_backwall.eo (@zmike)
• src/lib/elementary/efl_ui_focus_parent_provider.eo @segfaultxavi
• src/lib/elementary/efl_ui_box_flow.eo (@zmike) DONE @segfaultxavi
• src/lib/elementary/efl_ui_focus_composition_adapter.eo @segfaultxavi
• src/lib/elementary/efl_ui_list.eo @bu5hm4n DONE @segfaultxavi
• src/lib/elementary/efl_ui_alert_popup_part.eo (@zmike)
• src/lib/elementary/efl_ui_focus_util.eo @segfaultxavi
• src/lib/elementary/efl_ui_collection_focus_manager.eo @segfaultxavi
• src/lib/elementary/efl_ui_focus_parent_provider_standard.eo @segfaultxavi
• src/lib/elementary/efl_ui_grid.eo @bu5hm4n DONE @segfaultxavi
• src/lib/elementary/efl_ui_alert_popup.eo (@zmike)
• src/lib/elementary/efl_ui_focus_manager_root_focus.eo @segfaultxavi
• src/lib/elementary/efl_ui_group_item.eo @segfaultxavi
• src/lib/elementary/efl_ui_list_default_item.eo @bu5hm4n DONE @segfaultxavi
• src/lib/elementary/efl_ui_popup.eo (@zmike)
• src/lib/elementary/efl_ui_grid_default_item.eo @segfaultxavi
• src/lib/efl/interfaces/efl_gfx_arrangement.eo (@zmike)
• src/lib/ecore/efl_boolean_model.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/ecore/efl_exe.eo (@akanad ) DONE @segfaultxavi
• src/lib/elementary/efl_ui_focus_manager.eo (root, request_subchild, logical_end, dirty_logic_freeze) (@bu5hm4n) DONE @segfaultxavi
• src/lib/elementary/efl_ui_focus_object.eo (setup_order) (@bu5hm4n) DONE @segfaultxavi
• Replace Doxygen references like # with Eolian ones @. Locate files using find -name "*.eo" | xargs grep "#[a-zA-Z_]*" -l. For example, #EFL_UI_CLOCK_TYPE_YEAR --> @Efl.Ui.Clock_Type.year @segfaultxavi
• No line should be longer than 120 characters. @segfaultxavi
• src/lib/elementary/efl_ui_widget_scrollable_content.eo --> Missing @ tags (My comments on D9674 and D9676) @zmike
• src/lib/ecore/efl_threadio.eo @wc DONE @segfaultxavi
• src/lib/ecore/efl_appthread.eo @wc DONE @segfaultxavi
• src/lib/eo/efl_object.eo
• src/lib/elementary/efl_ui_image.eo
• src/lib/efl/interfaces/efl_part.eo
• src/lib/efl/interfaces/efl_gfx_path.eo
• src/lib/efl/interfaces/efl_ui_scrollable_interactive.eo
• src/lib/elementary/efl_ui_widget_part_bg.eo @bu5hm4n DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_double_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_flick.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_long_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_manager.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_momentum.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_double_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_flick.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_long_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_momentum.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_triple_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_recognizer_zoom.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_touch.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_triple_tap.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/evas/gesture/efl_canvas_gesture_zoom.eo (@myoungwoon) DONE @segfaultxavi
• src/lib/efl/interfaces/efl_model.eo @bu5hm4n DONE @segfaultxavi
• src/lib/efl/interfaces/efl_gfx_image_orientable.eo @segfaultxavi
• src/lib/evas/canvas/efl_input_hold.eo @segfaultxavi
• src/lib/efl/interfaces/efl_gfx_color_class.eo @segfaultxavi
• src/lib/ecore/efl_exe.eo (@akanad) DONE @segfaultxavi
• src/lib/ecore/efl_filter_model.eo (@akanad) DONE @segfaultxavi
• src/lib/efl/interfaces/efl_gfx_image.eo (@zmike) DONE @segfaultxavi
• src/lib/elementary/efl_ui_layout_factory.eo (@felipealmeida) DONE @segfaultxavi
• Use of $: Eolian only highlights letters and underscores. $one_two looks right, but $one.two looks wrong. Remove the $ in all the wrong cases. @segfaultxavi
• src/lib/efl/interfaces/efl_cached_item.eo @segfaultxavi
• src/lib/efl/interfaces/efl_ui_factory.eo @segfaultxavi
• src/lib/efl/interfaces/efl_ui_scrollable.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_alpha.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_group.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_rotate.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_scale.eo @segfaultxavi
• src/lib/evas/canvas/efl_canvas_animation_translate.eo @segfaultxavi
• src/lib/elementary/efl_ui_table_static.eo @segfaultxavi
• src/lib/ecore/efl_bounce_interpolator.eo @segfaultxavi
• src/lib/ecore/efl_cubic_bezier_interpolator.eo @segfaultxavi
• src/lib/ecore/efl_divisor_interpolator.eo @segfaultxavi
• src/lib/ecore/efl_linear_interpolator.eo @segfaultxavi
• src/lib/ecore/efl_spring_interpolator.eo @segfaultxavi
• src/lib/efl/interfaces/efl_interpolator.eo @segfaultxavi

Legacy:

• src/lib/ecore_audio/ecore_audio.eo
• src/lib/ecore_audio/ecore_audio_in.eo
• src/lib/ecore_audio/ecore_audio_in_sndfile.eo
• src/lib/ecore_audio/ecore_audio_in_tone.eo
• src/lib/ecore_audio/ecore_audio_out.eo
• src/lib/ecore_audio/ecore_audio_out_pulse.eo
• src/lib/ecore_audio/ecore_audio_out_sndfile.eo
• src/lib/ecore_audio/ecore_audio_out_wasapi.eo
• src/lib/ecore/ecore_event_message.eo
• src/lib/ector/cairo/ector_renderer_cairo.eo
• src/lib/ector/cairo/ector_renderer_cairo_gradient_linear.eo
• src/lib/ector/cairo/ector_renderer_cairo_gradient_radial.eo
• src/lib/ector/cairo/ector_renderer_cairo_shape.eo
• src/lib/ector/ector_renderer.eo
• src/lib/ector/ector_renderer_gradient.eo
• src/lib/ector/ector_renderer_gradient_linear.eo
• src/lib/ector/ector_renderer_gradient_radial.eo
• src/lib/ector/ector_renderer_image.eo
• src/lib/ector/ector_renderer_shape.eo
• src/lib/ector/ector_surface.eo
• src/lib/ector/gl/ector_gl_buffer.eo
• src/lib/ector/gl/ector_gl_surface.eo
• src/lib/ector/gl/ector_renderer_gl.eo
• src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo
• src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo
• src/lib/ector/gl/ector_renderer_gl_shape.eo
• src/lib/ector/software/ector_renderer_software.eo
• src/lib/ector/software/ector_renderer_software_gradient_linear.eo
• src/lib/ector/software/ector_renderer_software_gradient_radial.eo
• src/lib/ector/software/ector_renderer_software_image.eo
• src/lib/ector/software/ector_renderer_software_shape.eo
• src/lib/ector/software/ector_software_buffer_base.eo
• src/lib/ector/software/ector_software_buffer.eo
• src/lib/ector/software/ector_software_surface.eo
• src/lib/eio/eio_sentry.eo
• src/lib/eldbus/eldbus_model_arguments.eo (@segfaultxavi)
• src/lib/eldbus/eldbus_model_connection.eo (@segfaultxavi)
• src/lib/eldbus/eldbus_model_method.eo (@segfaultxavi)
• src/lib/eldbus/eldbus_model_object.eo (@segfaultxavi)
• src/lib/eldbus/eldbus_model_proxy.eo (@segfaultxavi)
• src/lib/eldbus/eldbus_model_signal.eo (@segfaultxavi)
• src/lib/elementary/elm_actionslider_part.eo
• src/lib/elementary/elm_bubble_part.eo
• src/lib/elementary/elm_code_widget.eo
• src/lib/elementary/elm_ctxpopup_part.eo
• src/lib/elementary/elm_dayselector_part.eo
• src/lib/elementary/elm_entry_part.eo
• src/lib/elementary/elm_fileselector_entry_part.eo
• src/lib/elementary/elm_fileselector_part.eo
• src/lib/elementary/elm_flip_part.eo
• src/lib/elementary/elm_hover_part.eo
• src/lib/elementary/elm_interface_scrollable.eo
• src/lib/elementary/elm_label_part.eo
• src/lib/elementary/elm_mapbuf_part.eo
• src/lib/elementary/elm_multibuttonentry_part.eo
• src/lib/elementary/elm_naviframe_part.eo
• src/lib/elementary/elm_panel_part.eo
• src/lib/elementary/elm_player_part.eo
• src/lib/elementary/elm_popup_part.eo
• src/lib/elementary/elm_scroller_part.eo
• src/lib/evas/canvas/evas_canvas3d_camera.eo
• src/lib/evas/canvas/evas_canvas3d_light.eo
• src/lib/evas/canvas/evas_canvas3d_material.eo
• src/lib/evas/canvas/evas_canvas3d_mesh.eo
• src/lib/evas/canvas/evas_canvas3d_node.eo
• src/lib/evas/canvas/evas_canvas3d_object.eo
• src/lib/evas/canvas/evas_canvas3d_primitive.eo
• src/lib/evas/canvas/evas_canvas3d_scene.eo
• src/lib/evas/canvas/evas_canvas3d_texture.eo