Edcref: fixed (I hope) the doc for parts aliases

This commit is contained in:
Davide Andreoli 2014-08-08 14:55:18 +02:00
parent cb84a5f994
commit 1eca781d1d
1 changed files with 12 additions and 2 deletions

View File

@ -2414,7 +2414,7 @@ st_styles_style_tag(void)
/** @edcsection{collections,Collections Blocks} */ /** @edcsection{collections,Collections Blocks} */
/** @edcsubsection{collections, /** @edcsubsection{collections,
* Collections Blocks} */ * Collections} */
/** /**
@page edcref @page edcref
@ -3975,15 +3975,25 @@ st_collections_group_limits_horizontal(void)
group { group {
parts { parts {
alias: "theme_part_path" "somegroup:real_part_path"; alias: "theme_part_path" "somegroup:real_part_path";
group { "theme_part_path"; } part { "theme_part_path"; }
part { }
..
} }
} }
@description @description
The parts block is the container for all the parts in the group.
@property
alias
@parameters
[alias name] [other_group:part name]
@effect
Allows for a part to be referenced externally as though Allows for a part to be referenced externally as though
it had the name of the alias. it had the name of the alias.
In the above example, swallowing an object into part "theme_part_path" In the above example, swallowing an object into part "theme_part_path"
will result in the object actually being swallowed into the part will result in the object actually being swallowed into the part
"real_part_path" in the "somegroup" group. "real_part_path" in the "somegroup" group.
@endproperty
@endblock @endblock
*/ */
static void static void