Commit 066d9913 authored by Michael Meeks's avatar Michael Meeks

update docs to explain why setting elements on mstyle_new_default is a

terrible idea.
parent d4430e2f
...@@ -21,7 +21,8 @@ adopted. This document breaks roughly into two parts. First the 'user' ...@@ -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 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 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: b) Set elements:
......
...@@ -21,7 +21,8 @@ adopted. This document breaks roughly into two parts. First the 'user' ...@@ -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 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 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: b) Set elements:
......
...@@ -486,6 +486,15 @@ mstyle_new_name (const gchar *name) ...@@ -486,6 +486,15 @@ mstyle_new_name (const gchar *name)
static MStyle *default_mstyle = NULL; 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 *
mstyle_new_default (void) mstyle_new_default (void)
{ {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment