Edje: Improve EDC reference doc index

Author:    Ricardo de Almeida Gonzaga <ricardo@profusion.mobi>

SVN revision: 79906
This commit is contained in:
Jonas M. Gastal 2012-11-30 13:48:56 +00:00
parent f9e04d392a
commit e95cb8f584
3 changed files with 180 additions and 18 deletions

View File

@ -189,6 +189,7 @@ ALIASES += parameters="</tt></td><td class=\"parameters\"><tt>"
ALIASES += effect="</tt></td></tr><tr><td>&nbsp;</td><td class=\"effect\">"
ALIASES += endproperty="</td></tr></table></td></tr>"
ALIASES += edcsection{2}="<tr class=\"section\"><td class=\"section\" colspan=\"2\">\anchor sec_\1 \ref sec_quickaccess \"\2\"</td></tr>"
ALIASES += edcsubsection{2}="<tr class=\"subsection\"><td class=\"subsection\" colspan=\"2\">\anchor sec_\1 \ref sec_quickaccess \"\2\"</td></tr>"
# Aliases used by luaref
ALIASES += luaclass{2}="\anchor \1 \n<div class=\"luaclass\">\2</div>"

View File

@ -289,6 +289,18 @@ table.edcref tr.section td.section a {
text-decoration: none;
}
table.edcref tr.subsection td.subsection, div.luaclass {
color: #888;
font-size: 11pt;
padding: 1px;
text-align: center;
}
table.edcref tr.subsection td.subsection a {
color: #888;
text-decoration: none;
}
div.luaattrib {
color: #888;
border: 1px solid #ccc;

View File

@ -48,16 +48,69 @@
* @anchor sec_quickaccess Quick access to block descriptions:
* <ul>
* <li>@ref sec_toplevel "Top-Level"</li>
* <li>@ref sec_group "Group"</li>
* <li>@ref sec_description "State description"</li>
* <ul>
* <li>@ref sec_description_image "Image"</li>
* <li>@ref sec_description_text "Text"</li>
* <li>@ref sec_description_box "Box"</li>
* <li>@ref sec_description_table "Table"</li>
* <li>@ref sec_description_map "Map (3d/transformations)"</li>
* <li>@ref sec_toplevel_externals "Externals"</li>
* <li>@ref sec_toplevel_images "Images"</li>
* <ul>
* <li>@ref sec_toplevel_images_set "Set"</li>
* <ul>
* <li>@ref sec_toplevel_images_image "Image"</li>
* </ul>
* </ul>
* <li>@ref sec_toplevel_fonts "Fonts"</li>
* <li>@ref sec_toplevel_data "Data"</li>
* <li>@ref sec_toplevel_color_classes "Color Classes"</li>
* <li>@ref sec_toplevel_styles "Styles"</li>
* </ul>
* <li>@ref sec_collections "Collections"</li>
* <ul>
* <li>@ref sec_collections_sounds "Sounds"</li>
* <ul>
* <li>@ref sec_collections_sounds_sample "Sample"</li>
* </ul>
* <li>@ref sec_collections_group "Group"</li>
* <ul>
* <li>@ref sec_collections_group_script "Script"</li>
* <li>@ref sec_collections_group_limits "Limits"</li>
* <li>@ref sec_toplevel_data "Data"</li>
* <li>@ref sec_collections_group_parts "Parts"</li>
* <ul>
* <li>@ref sec_collections_group_parts_part "Part"</li>
* <ul>
* <li>@ref sec_collections_group_parts_dragable "Dragable"</li>
* <li>@ref sec_collections_group_parts_items "Items"</li>
* <li>@ref sec_collections_group_parts_description "Description"</li>
* <ul>
* <li>@ref sec_collections_group_parts_description_relatives "Relatives (rel1/rel2)"</li>
* <li>@ref sec_collections_group_parts_description_image "Image"</li>
* <ul>
* <li>@ref sec_collections_group_parts_description_image_fill "Fill"</li>
* <ul>
* <li>@ref sec_collections_group_parts_description_image_fill_origin "Origin"</li>
* <li>@ref sec_collections_group_parts_description_image_fill_size "Size"</li>
* </ul>
* </ul>
* <li>@ref sec_collections_group_parts_description_text "Text"</li>
* <li>@ref sec_collections_group_parts_description_box "Box"</li>
* <ul>
* <li>@ref sec_collections_group_parts_items "Items"</li>
* </ul>
* <li>@ref sec_collections_group_parts_description_table "Table"</li>
* <li>@ref sec_collections_group_parts_description_map "Map (3d/transformations)"</li>
* <ul>
* <li>@ref sec_collections_group_parts_description_map_rotation "Rotation"</li>
* </ul>
* <li>@ref sec_collections_group_parts_description_perspective "Perspective"</li>
* <li>@ref sec_collections_group_parts_descriptions_params "Params"</li>
* </ul>
* </ul>
* </ul>
* <li>@ref sec_collections_group_programs "Programs"</li>
* <ul>
* <li>@ref sec_collections_group_script "Script"</li>
* </ul>
* </ul>
* </ul>
* <li>@ref sec_program "Program block"</li>
* </ul>
*
* @author Andres Blanc (dresb) andresblanc@gmail.com
@ -1150,6 +1203,10 @@ _edje_program_copy(Edje_Program *ep, Edje_Program *ep2)
@edcsection{toplevel,Top-Level blocks}
*/
/**
@edcsubsection{toplevel_externals,Externals}
*/
/**
@page edcref
@ -1217,6 +1274,10 @@ st_externals_external(void)
}
}
/**
@edcsubsection{toplevel_images,Images}
*/
/**
@page edcref
@ -1342,6 +1403,10 @@ st_images_image(void)
}
}
/**
@edcsubsection{toplevel_images_set,Set}
*/
/**
@page edcref
@ -1413,6 +1478,10 @@ st_images_set_name(void)
edje_file->image_dir->sets[edje_file->image_dir->sets_count - 1].name = parse_str(0);
}
/**
@edcsubsection{toplevel_images_image,Image}
*/
/**
@page edcref
@ -1512,6 +1581,10 @@ st_images_set_image_size(void)
}
}
/**
@edcsubsection{toplevel_fonts,Fonts}
*/
/**
@page edcref
@ -1563,6 +1636,10 @@ st_fonts_font(void)
eina_hash_direct_add(edje_file->fonts, fn->name, fn);
}
/**
@edcsubsection{toplevel_data,Data}
*/
/**
@page edcref
@block
@ -1684,6 +1761,10 @@ st_data_file(void)
free(filename);
}
/**
@edcsubsection{toplevel_color_classes,Color Classes}
*/
/**
@page edcref
@block
@ -1830,6 +1911,10 @@ st_color_class_color3(void)
cc->a3 = parse_int_range(3, 0, 255);
}
/**
@edcsubsection{toplevel_styles,Styles}
*/
/**
@page edcref
@block
@ -1945,6 +2030,10 @@ st_styles_style_tag(void)
stl->tags = eina_list_append(stl->tags, tag);
}
/**
@edcsection{collections,Collections Blocks}
*/
/**
@page edcref
@block
@ -1973,6 +2062,10 @@ ob_collections(void)
}
}
/**
@edcsubsection{collections_sounds,Sounds}
*/
/**
@page edcref
@block
@ -1993,6 +2086,14 @@ ob_collections(void)
@description
The "sounds" block contains a list of one or more sound sample and tones items.
@endblock
*/
/**
@edcsubsection{collections_sounds_sample,Sample}
*/
/**
@page edcref
@block
sample
@context
@ -2187,7 +2288,7 @@ st_collections_group_sound_tone(void)
}
/**
@edcsection{group,Group sub blocks}
@edcsubsection{collections_group,Group}
*/
/**
@ -2705,6 +2806,10 @@ st_collections_group_broadcast_signal(void)
pc->broadcast_signal = parse_bool(0);
}
/**
@edcsubsection{collections_group_script,Script}
*/
/**
@page edcref
@block
@ -2848,6 +2953,10 @@ st_collections_group_orientation(void)
NULL);
}
/**
@edcsubsection{collections_group_limits,Limits}
*/
/**
@page edcref
@block
@ -2941,6 +3050,10 @@ st_collections_group_limits_horizontal(void)
el->value = parse_int_range(1, 1, 0xffff);
}
/**
@edcsubsection{collections_group_parts,Parts}
*/
/**
@page edcref
@block
@ -2978,6 +3091,9 @@ st_collections_group_parts_alias(void)
eina_hash_add(pc->aliased, aliased, alias);
}
/**
@edcsubsection{collections_group_parts_part,Part}
*/
/**
@page edcref
@ -3857,6 +3973,10 @@ st_collections_group_parts_part_access(void)
current_part->access = parse_bool(0);
}
/**
@edcsubsection{collections_group_parts_dragable,Dragable}
*/
/**
@page edcref
@block
@ -3986,6 +4106,10 @@ st_collections_group_parts_part_dragable_events(void)
}
}
/**
@edcsubsection{collections_group_parts_items,Items}
*/
/**
@page edcref
@block
@ -4390,7 +4514,7 @@ static void st_collections_group_parts_part_table_items_item_span(void)
}
/**
@edcsection{description,State description sub blocks}
@edcsubsection{collections_group_parts_description,Description}
*/
/**
@ -5240,6 +5364,10 @@ st_collections_group_parts_part_description_color3(void)
ed->text.color3.a = parse_int_range(3, 0, 255);
}
/**
@edcsubsection{collections_group_parts_description_relatives,Relatives (rel1/rel2)}
*/
/**
@page edcref
@block
@ -5473,7 +5601,7 @@ st_collections_group_parts_part_description_rel2_to_y(void)
}
/**
@edcsection{description_image,Image state description sub blocks}
@edcsubsection{collections_group_parts_description_image,Image}
*/
/**
@ -5753,6 +5881,10 @@ st_collections_group_parts_part_description_image_scale_hint(void)
NULL);
}
/**
@edcsubsection{collections_group_parts_description_image_fill,Fill}
*/
/**
@page edcref
@block
@ -5930,6 +6062,10 @@ st_collections_group_parts_part_description_fill_type(void)
NULL);
}
/**
@edcsubsection{collections_group_parts_description_image_fill_origin,Origin}
*/
/**
@page edcref
@block
@ -6051,6 +6187,10 @@ st_collections_group_parts_part_description_fill_origin_offset(void)
fill->pos_abs_y = parse_int(1);
}
/**
@edcsubsection{collections_group_parts_description_image_fill_size,Size}
*/
/**
@page edcref
@block
@ -6176,7 +6316,7 @@ st_collections_group_parts_part_description_fill_size_offset(void)
/**
@edcsection{description_text,Text state description sub blocks}
@edcsubsection{collections_group_parts_description_text,Text}
*/
/**
@ -6703,7 +6843,7 @@ st_collections_group_parts_part_description_text_elipsis(void)
/**
@edcsection{description_box,Box state description sub blocks}
@edcsubsection{collections_group_parts_description_box,Box}
*/
/**
@ -6858,7 +6998,7 @@ st_collections_group_parts_part_description_box_min(void)
/**
@edcsection{description_table,Table state description sub blocks}
@edcsubsection{collections_group_parts_description_table,Table}
*/
/**
@ -7004,7 +7144,7 @@ st_collections_group_parts_part_description_table_min(void)
}
/**
@edcsection{description_map,Map state description sub blocks}
@edcsubsection{collections_group_parts_description_map,Map}
*/
/**
@ -7200,6 +7340,11 @@ st_collections_group_parts_part_description_map_perspective_on(void)
current_desc->map.persp_on = parse_bool(0);
}
/**
@edcsubsection{collections_group_parts_description_map_rotation,Rotation}
*/
/**
@page edcref
@block
@ -7306,6 +7451,10 @@ st_collections_group_parts_part_description_map_rotation_z(void)
current_desc->map.rot.z = FROM_DOUBLE(parse_float(0));
}
/**
@edcsubsection{collections_group_parts_description_perspective,Perspective}
*/
/**
@page edcref
@block
@ -7363,7 +7512,7 @@ st_collections_group_parts_part_description_perspective_focal(void)
/**
@edcsection{description_params,Params state description sub blocks}
@edcsubsection{collections_group_parts_descriptions_params,Params}
*/
/**
@ -7537,13 +7686,13 @@ st_collections_group_parts_part_description_params_choice(void)
/**
@edcsection{program, Program block}
@edcsubsection{collections_group_programs,Programs}
*/
/**
@page edcref
@block
program
programs
@context
group {
programs {