diff options
author | Dave Andreoli <dave@gurumeditation.it> | 2019-10-05 10:30:34 +0200 |
---|---|---|
committer | Dave Andreoli <dave@gurumeditation.it> | 2019-10-05 12:21:28 +0200 |
commit | 40676af38390b08518d8f5a24fa2c2cc0aa05723 (patch) | |
tree | 7020cfc1c112728f072c5f8527a164640c58d70b | |
parent | 13e856075c787b0f6bfe2e547083b0be4b10e50f (diff) | |
download | efl-40676af38390b08518d8f5a24fa2c2cc0aa05723.tar.gz |
Pyolian gendoc: highlight classes in beta state
-rw-r--r-- | src/scripts/gendoc/doc_alias.template | 4 | ||||
-rw-r--r-- | src/scripts/gendoc/doc_class.template | 4 | ||||
-rw-r--r-- | src/scripts/gendoc/doc_enum.template | 4 | ||||
-rw-r--r-- | src/scripts/gendoc/doc_macros.include | 10 | ||||
-rw-r--r-- | src/scripts/gendoc/doc_start.template | 14 | ||||
-rw-r--r-- | src/scripts/gendoc/doc_struct.template | 4 |
6 files changed, 33 insertions, 7 deletions
diff --git a/src/scripts/gendoc/doc_alias.template b/src/scripts/gendoc/doc_alias.template index 0f3382344b..4f426be88c 100644 --- a/src/scripts/gendoc/doc_alias.template +++ b/src/scripts/gendoc/doc_alias.template @@ -2,6 +2,10 @@ ~~Title: ${alias.name}$~~ ====== ${alias.name}$ (alias) ====== +<!--(if alias.is_beta)--> +''beta'' This alias is still in beta, api will probably change +<!--(end)--> + ${BEST_SUMMARY(obj=alias)}$ ${BEST_DESCRIPTION(obj=alias)}$ diff --git a/src/scripts/gendoc/doc_class.template b/src/scripts/gendoc/doc_class.template index 14f1f568a1..04910d619d 100644 --- a/src/scripts/gendoc/doc_class.template +++ b/src/scripts/gendoc/doc_class.template @@ -2,6 +2,10 @@ ~~Title: ${cls.name}$~~ ====== ${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_DESCRIPTION(obj=cls)}$ diff --git a/src/scripts/gendoc/doc_enum.template b/src/scripts/gendoc/doc_enum.template index f7a11ee6c4..c097134239 100644 --- a/src/scripts/gendoc/doc_enum.template +++ b/src/scripts/gendoc/doc_enum.template @@ -2,6 +2,10 @@ ~~Title: ${enum.name}$~~ ====== ${enum.name}$ (enum) ====== +<!--(if enum.is_beta)--> +''beta'' This enumeration is still in beta, api will probably change +<!--(end)--> + ${BEST_SUMMARY(obj=enum)}$ ${BEST_DESCRIPTION(obj=enum)}$ diff --git a/src/scripts/gendoc/doc_macros.include b/src/scripts/gendoc/doc_macros.include index d818363ee9..6dfd45e6d7 100644 --- a/src/scripts/gendoc/doc_macros.include +++ b/src/scripts/gendoc/doc_macros.include @@ -216,6 +216,7 @@ interface#! <!--(elif ev.is_restart)--> ''restart'' #! <!--(end)--> +${OBJ_TAGS(obj=ev)}$ <!--(end)--> #!############################################################################## #!#### IMPLEMENT_TAGS(impl) ################################################## @@ -228,6 +229,15 @@ interface#! <!--(elif impl.is_prop_set)--> ''write only'' #! <!--(end)--> +${OBJ_TAGS(obj=impl)}$ +<!--(end)--> +#!############################################################################## +#!#### OBJ_TAGS(obj) ######################################################### +#!############################################################################## +<!--(macro OBJ_TAGS)--> + <!--(if obj.is_beta)--> + ''beta'' #! + <!--(end)--> <!--(end)--> #!############################################################################## #!#### PARAM_DIRECTION_TAG(param) ############################################ diff --git a/src/scripts/gendoc/doc_start.template b/src/scripts/gendoc/doc_start.template index 3a5ebfefbd..ad85ad7bdc 100644 --- a/src/scripts/gendoc/doc_start.template +++ b/src/scripts/gendoc/doc_start.template @@ -17,49 +17,49 @@ so it can be considered valid for all languages. <!--(if i == 0)--> ^ Regular Classes ^^ <!--(end)--> -| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | +| ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ | <!--(end)--> #! <!--(for i, cls in enumerate(sorted(ns.abstracts)))--> <!--(if i == 0)--> ^ Abstract Classes ^^ <!--(end)--> -| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | +| ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ | <!--(end)--> #! <!--(for i, cls in enumerate(sorted(ns.mixins)))--> <!--(if i == 0)--> ^ Mixins ^^ <!--(end)--> -| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | +| ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ | <!--(end)--> #! <!--(for i, cls in enumerate(sorted(ns.interfaces)))--> <!--(if i == 0)--> ^ Interfaces ^^ <!--(end)--> -| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ | +| ${CLS_LINK}$ ${OBJ_TAGS(obj=cls)}$ | ${BEST_SUMMARY(obj=cls)}$ | <!--(end)--> #! <!--(for i, typedecl in enumerate(sorted(ns.aliases)))--> <!--(if i == 0)--> ^ Aliases ^^ <!--(end)--> -| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ | +| ${TYPEDECL_LINK}$ ${OBJ_TAGS(obj=typedecl)}$ | ${BEST_SUMMARY(obj=typedecl)}$ | <!--(end)--> #! <!--(for i, typedecl in enumerate(sorted(ns.structs)))--> <!--(if i == 0)--> ^ Structures ^^ <!--(end)--> -| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ | +| ${TYPEDECL_LINK}$ ${OBJ_TAGS(obj=typedecl)}$ | ${BEST_SUMMARY(obj=typedecl)}$ | <!--(end)--> #! <!--(for i, typedecl in enumerate(sorted(ns.enums)))--> <!--(if i == 0)--> ^ Enumerations ^^ <!--(end)--> -| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ | +| ${TYPEDECL_LINK}$ ${OBJ_TAGS(obj=typedecl)}$ | ${BEST_SUMMARY(obj=typedecl)}$ | <!--(end)--> <!--(end)--> diff --git a/src/scripts/gendoc/doc_struct.template b/src/scripts/gendoc/doc_struct.template index 306dcfd961..e354b6f6a1 100644 --- a/src/scripts/gendoc/doc_struct.template +++ b/src/scripts/gendoc/doc_struct.template @@ -2,6 +2,10 @@ ~~Title: ${struct.name}$~~ ====== ${struct.name}$ (struct) ====== +<!--(if struct.is_beta)--> +''beta'' This struct is still in beta, api will probably change +<!--(end)--> + ${BEST_SUMMARY(obj=struct)}$ ${BEST_DESCRIPTION(obj=struct)}$ |