#!############################################################################## #!#### BEST_SUMMARY(obj) ##################################################### #!############################################################################## ${UNTOKENIZE(tokens=obj.summary_tokens)}$#! ${UNTOKENIZE(tokens=obj.documentation_get(obj.function.type).summary_tokens)}$#! ${UNTOKENIZE(tokens=parent_impl.documentation_get(parent_impl.function.type).summary_tokens)}$#! ${UNTOKENIZE(tokens=obj.documentation.summary_tokens)}$#! **MISSING DOCS !!!!!**#! #!############################################################################## #!#### BEST_DESCRIPTION(obj) ################################################# #!############################################################################## ${UNTOKENIZE(tokens=obj.description_tokens)}$#! ${UNTOKENIZE(tokens=obj.documentation_get(obj.function.type).description_tokens)}$#! ${UNTOKENIZE(tokens=parent_impl.documentation_get(parent_impl.function.type).description_tokens)}$#! ${UNTOKENIZE(tokens=obj.documentation.description_tokens)}$#! **MISSING DOCS !!!!!**#! #!############################################################################## #!#### BEST_SINCE(obj) ####################################################### #!############################################################################## //Since ${obj.since}$// //Since ${obj.documentation_get(obj.function.type).since}$// //Since ${parent_impl.documentation_get(parent_impl.function.type).since}$// //Since ${obj.documentation.since}$// #!############################################################################## #!#### UNTOKENIZE(tokens) #################################################### #!############################################################################## ${'\n\n' if i else ''}$#! %%${token.text}$%%#! **REF ${token.text}$ ${token.ref}$ ??**#! ''${token.text}$''#! ${token.text}$ ${token.text}$ ${token.text}$ **TODO:** ${token.text}$ **USUPPORTED TOKEN TYPE ${token}$** #!############################################################################## #!#### CLS_TYPE(cls) ######################################################### #!############################################################################## class#! class#! mixin#! interface#! #!############################################################################## #!#### CLS_LINK(cls) ######################################################### #!############################################################################## [[:develop:api#! :${n.lower()}$#! :${cls.short_name.lower()}$|${cls.name}$]] #!############################################################################## #!#### EVENT_LINK(cls, ev) ################################################### #!############################################################################## [[:develop:api#! :${n.lower()}$#! :${cls.short_name.lower()}$#! :event#! :${ev.short_name.lower().replace(',','_')}$|${ev.name}$]] #!############################################################################## #!#### TYPEDECL_LINK(typedecl) ############################################### #!############################################################################## [[:develop:api#! :${n.lower()}$#! :${typedecl.short_name.lower()}$|${typedecl.name}$]] #!############################################################################## #!#### TYPE_LINK(type) ####################################################### #!############################################################################## [[:develop:api#! :${n.lower()}$#! :${type.short_name.lower()}$|${type.name}$]] #!############################################################################## #!#### FUNC_LINK(func) ####################################################### #!############################################################################## [[:develop:api#! :${n.lower()}$#! :method#! :property#! :${func.short_name}$|${func.short_name}$]] #!############################################################################## #!#### FUNC_SCOPE(func) ###################################################### #!############################################################################## ''class method'' #! ''protected get'' #! ''private get'' #! ''protected set'' #! ''private set'' #! ''protected'' #! ''private'' #! #!############################################################################## #!#### OBJECT_SCOPE(obj) ##################################################### #!############################################################################## ''private'' #! ''protected'' #! #!############################################################################## #!#### EVENT_TAGS(ev) ######################################################## #!############################################################################## ''hot'' #! ''restart'' #! #!############################################################################## #!#### IMPLEMENT_TAGS(impl) ################################################## #!############################################################################## ''rw'' #! ''read only'' #! ''write only'' #! #!############################################################################## #!#### PARAM_DIRECTION_TAG(param) ############################################ #!############################################################################## ''in'' #! ''out'' #! ''inout'' #! #!############################################################################## #!#### METHOD_PARAMS(func) ################################################### #!############################################################################## ^ parameters ^ type ^ description ^ |${PARAM_DIRECTION_TAG(param=par)}$ **${par.name}$**|${par.type.name}$ #! |${BEST_SUMMARY(obj=par)}$ ${BEST_DESCRIPTION(obj=par)}$| **This function do not accept any parameter.** ${setvar("obj", "func.return_documentation(Eolian_Function_Type.METHOD)")}$#! ^ return ^ description ^ |**${func.method_return_type.name}$**|${BEST_SUMMARY(obj=obj)}$ ${BEST_DESCRIPTION(obj=obj)}$| **This function do not return anything.** #!############################################################################## #!#### PROPERTY_PARAMS(func) ################################################# #!############################################################################## ^ values ^ type ^ description ^ |**${val.name}$**|${val.type.name}$|${BEST_SUMMARY(obj=val)}$| ^ keys ^ type ^ description ^ |**${key.name}$**|${key.type.name}$|${BEST_SUMMARY(obj=key)}$| #!############################################################################## #!#### IMPLEMENT_FULL(impl, cls) ############################################# #!############################################################################## **${FUNC_LINK(func=impl.function)}$** #! (#! ${', ' if i else ''}$${val.type.short_name}$#! ${', ' if i else ''}$#! //${param.type.short_name}$// ''${param.direction.name.lower()}$'' **${param.short_name}$**#! ) #! ${IMPLEMENT_TAGS}$ #! => //${impl.function.method_return_type.short_name}$// #! => //None// #! ${FUNC_SCOPE(func=impl.function)}$#! //[Overridden from ${CLS_LINK(cls=impl.class_)}$]// #! \\ > ${BEST_SUMMARY(obj=impl)}$ ${BEST_SINCE(obj=impl)}$ ++++ more... | ${BEST_DESCRIPTION(obj=impl)}$ ${METHOD_PARAMS(func=impl.function)}$ ${PROPERTY_PARAMS(func=impl.function)}$ ++++ #!############################################################################## #!#### OBJECT_STATIC_CONTENT(obj, section) ################################### #!############################################################################## {{page>:develop:api-include#! :${ns.lower()}$#! :${obj.name.lower()}$#! :{section}#! &nouser&nolink&nodate}}