diff --git a/doc/Styles.txt b/doc/Styles.txt index 9eb6c90d49fdac6fe34ce98fbe62e62b2b17a8ba..b93b90a2cb0b3b28150f955bcca35a66c1556482 100644 --- a/doc/Styles.txt +++ b/doc/Styles.txt @@ -21,7 +21,8 @@ adopted. This document breaks roughly into two parts. First the 'user' In future named styles will be possible, also to get the default style use mstyle_new_default (). NB. the name 'mstyle' is standard for this - structure's instances. + structure's instances. NB. do _not_ set any of the fields on the default + style. b) Set elements: diff --git a/doc/developer/Styles.txt b/doc/developer/Styles.txt index 9eb6c90d49fdac6fe34ce98fbe62e62b2b17a8ba..b93b90a2cb0b3b28150f955bcca35a66c1556482 100644 --- a/doc/developer/Styles.txt +++ b/doc/developer/Styles.txt @@ -21,7 +21,8 @@ adopted. This document breaks roughly into two parts. First the 'user' In future named styles will be possible, also to get the default style use mstyle_new_default (). NB. the name 'mstyle' is standard for this - structure's instances. + structure's instances. NB. do _not_ set any of the fields on the default + style. b) Set elements: diff --git a/src/mstyle.c b/src/mstyle.c index c1e73b5857bd5be43034408242e739b3f79e4d8b..0f4c5ed36088cf447ecbd4b495a174b92c568aaa 100644 --- a/src/mstyle.c +++ b/src/mstyle.c @@ -486,6 +486,15 @@ mstyle_new_name (const gchar *name) static MStyle *default_mstyle = NULL; +/** + * mstyle_new_default: + * + * Return the default style, + * this should _never_ _ever_ have any of its elements + * set. + * + * Return value: the default style. + **/ MStyle * mstyle_new_default (void) {