Pyolian gendoc: highlight classes in beta state

This commit is contained in:
Davide Andreoli 2019-10-05 10:30:34 +02:00
parent 13e856075c
commit 40676af383
6 changed files with 33 additions and 7 deletions

View File

@ -2,6 +2,10 @@
~~Title: ${alias.name}$~~ ~~Title: ${alias.name}$~~
====== ${alias.name}$ (alias) ====== ====== ${alias.name}$ (alias) ======
<!--(if alias.is_beta)-->
''beta'' This alias is still in beta, api will probably change
<!--(end)-->
${BEST_SUMMARY(obj=alias)}$ ${BEST_SUMMARY(obj=alias)}$
${BEST_DESCRIPTION(obj=alias)}$ ${BEST_DESCRIPTION(obj=alias)}$

View File

@ -2,6 +2,10 @@
~~Title: ${cls.name}$~~ ~~Title: ${cls.name}$~~
====== ${cls.name}$ (${CLS_TYPE}$) ====== ====== ${cls.name}$ (${CLS_TYPE}$) ======
<!--(if cls.is_beta)-->
''beta'' This class is still in beta, api will probably change
<!--(end)-->
${BEST_SUMMARY(obj=cls)}$ ${BEST_SUMMARY(obj=cls)}$
${BEST_DESCRIPTION(obj=cls)}$ ${BEST_DESCRIPTION(obj=cls)}$

View File

@ -2,6 +2,10 @@
~~Title: ${enum.name}$~~ ~~Title: ${enum.name}$~~
====== ${enum.name}$ (enum) ====== ====== ${enum.name}$ (enum) ======
<!--(if enum.is_beta)-->
''beta'' This enumeration is still in beta, api will probably change
<!--(end)-->
${BEST_SUMMARY(obj=enum)}$ ${BEST_SUMMARY(obj=enum)}$
${BEST_DESCRIPTION(obj=enum)}$ ${BEST_DESCRIPTION(obj=enum)}$

View File

@ -216,6 +216,7 @@ interface#!
<!--(elif ev.is_restart)--> <!--(elif ev.is_restart)-->
''restart'' #! ''restart'' #!
<!--(end)--> <!--(end)-->
${OBJ_TAGS(obj=ev)}$
<!--(end)--> <!--(end)-->
#!############################################################################## #!##############################################################################
#!#### IMPLEMENT_TAGS(impl) ################################################## #!#### IMPLEMENT_TAGS(impl) ##################################################
@ -228,6 +229,15 @@ interface#!
<!--(elif impl.is_prop_set)--> <!--(elif impl.is_prop_set)-->
''write only'' #! ''write only'' #!
<!--(end)--> <!--(end)-->
${OBJ_TAGS(obj=impl)}$
<!--(end)-->
#!##############################################################################
#!#### OBJ_TAGS(obj) #########################################################
#!##############################################################################
<!--(macro OBJ_TAGS)-->
<!--(if obj.is_beta)-->
''beta'' #!
<!--(end)-->
<!--(end)--> <!--(end)-->
#!############################################################################## #!##############################################################################
#!#### PARAM_DIRECTION_TAG(param) ############################################ #!#### PARAM_DIRECTION_TAG(param) ############################################

View File

@ -17,49 +17,49 @@ so it can be considered valid for all languages.
<!--(if i == 0)--> <!--(if i == 0)-->
^ Regular Classes ^^ ^ Regular Classes ^^
<!--(end)--> <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | | ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ |
<!--(end)--> <!--(end)-->
#! #!
<!--(for i, cls in enumerate(sorted(ns.abstracts)))--> <!--(for i, cls in enumerate(sorted(ns.abstracts)))-->
<!--(if i == 0)--> <!--(if i == 0)-->
^ Abstract Classes ^^ ^ Abstract Classes ^^
<!--(end)--> <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | | ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ |
<!--(end)--> <!--(end)-->
#! #!
<!--(for i, cls in enumerate(sorted(ns.mixins)))--> <!--(for i, cls in enumerate(sorted(ns.mixins)))-->
<!--(if i == 0)--> <!--(if i == 0)-->
^ Mixins ^^ ^ Mixins ^^
<!--(end)--> <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | | ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ |
<!--(end)--> <!--(end)-->
#! #!
<!--(for i, cls in enumerate(sorted(ns.interfaces)))--> <!--(for i, cls in enumerate(sorted(ns.interfaces)))-->
<!--(if i == 0)--> <!--(if i == 0)-->
^ Interfaces ^^ ^ Interfaces ^^
<!--(end)--> <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | | ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ |
<!--(end)--> <!--(end)-->
#! #!
<!--(for i, typedecl in enumerate(sorted(ns.aliases)))--> <!--(for i, typedecl in enumerate(sorted(ns.aliases)))-->
<!--(if i == 0)--> <!--(if i == 0)-->
^ Aliases ^^ ^ Aliases ^^
<!--(end)--> <!--(end)-->
| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ | | ${TYPEDECL_LINK}$ ${OBJ_TAGS(obj=typedecl)}$ | ${BEST_SUMMARY(obj=typedecl)}$ |
<!--(end)--> <!--(end)-->
#! #!
<!--(for i, typedecl in enumerate(sorted(ns.structs)))--> <!--(for i, typedecl in enumerate(sorted(ns.structs)))-->
<!--(if i == 0)--> <!--(if i == 0)-->
^ Structures ^^ ^ Structures ^^
<!--(end)--> <!--(end)-->
| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ | | ${TYPEDECL_LINK}$ ${OBJ_TAGS(obj=typedecl)}$ | ${BEST_SUMMARY(obj=typedecl)}$ |
<!--(end)--> <!--(end)-->
#! #!
<!--(for i, typedecl in enumerate(sorted(ns.enums)))--> <!--(for i, typedecl in enumerate(sorted(ns.enums)))-->
<!--(if i == 0)--> <!--(if i == 0)-->
^ Enumerations ^^ ^ Enumerations ^^
<!--(end)--> <!--(end)-->
| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ | | ${TYPEDECL_LINK}$ ${OBJ_TAGS(obj=typedecl)}$ | ${BEST_SUMMARY(obj=typedecl)}$ |
<!--(end)--> <!--(end)-->
<!--(end)--> <!--(end)-->

View File

@ -2,6 +2,10 @@
~~Title: ${struct.name}$~~ ~~Title: ${struct.name}$~~
====== ${struct.name}$ (struct) ====== ====== ${struct.name}$ (struct) ======
<!--(if struct.is_beta)-->
''beta'' This struct is still in beta, api will probably change
<!--(end)-->
${BEST_SUMMARY(obj=struct)}$ ${BEST_SUMMARY(obj=struct)}$
${BEST_DESCRIPTION(obj=struct)}$ ${BEST_DESCRIPTION(obj=struct)}$