diff options
| author | Tamito Kajiyama <rd6t-kjym@asahi-net.or.jp> | 2010-04-18 03:47:47 +0400 |
|---|---|---|
| committer | Tamito Kajiyama <rd6t-kjym@asahi-net.or.jp> | 2010-04-18 03:47:47 +0400 |
| commit | d7e08f2d33207fdf76b1b597ef0de9dec26e3987 (patch) | |
| tree | b310235b1d441e160c50bbfb7eceadb090694339 /source/blender/freestyle/intern/python/BPy_MediumType.cpp | |
| parent | 11fc330f7ecfcb60bac3e29a83016ec7dfb85182 (diff) | |
Major documentation updates. The original Freestyle API reference
(http://freestyle.sourceforge.net/doc/html/index.html) has been
incorporated into the Blender/Freestyle Python API implementation
in the form of Sphinx-based embedded docstrings. Some C++-specific
descriptions of classes and functions were revised so that they are
suitable for Python programmers. Missing docstrings were filled,
and sparse descriptions were extended. By means of the new
documentation system for Blender, an up-to-date Freestyle Python
API reference will be part of the Blender 2.5 documentation.
Diffstat (limited to 'source/blender/freestyle/intern/python/BPy_MediumType.cpp')
| -rw-r--r-- | source/blender/freestyle/intern/python/BPy_MediumType.cpp | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/source/blender/freestyle/intern/python/BPy_MediumType.cpp b/source/blender/freestyle/intern/python/BPy_MediumType.cpp index c3ccefd4136..63a889e4786 100644 --- a/source/blender/freestyle/intern/python/BPy_MediumType.cpp +++ b/source/blender/freestyle/intern/python/BPy_MediumType.cpp @@ -10,6 +10,14 @@ extern "C" { /*-----------------------BPy_MediumType type definition ------------------------------*/ +static char MediumType___doc__[] = +"The different blending modes available to similate the interaction\n" +"media-medium:\n" +"\n" +"* Stroke.DRY_MEDIUM: To simulate a dry medium such as Pencil or Charcoal.\n" +"* Stroke.HUMID_MEDIUM: To simulate ink painting (color substraction blending).\n" +"* Stroke.OPAQUE_MEDIUM: To simulate an opaque medium (oil, spray...).\n"; + PyTypeObject MediumType_Type = { PyVarObject_HEAD_INIT(NULL, 0) "MediumType", /* tp_name */ @@ -31,7 +39,7 @@ PyTypeObject MediumType_Type = { 0, /* tp_setattro */ 0, /* tp_as_buffer */ Py_TPFLAGS_DEFAULT, /* tp_flags */ - "MediumType objects", /* tp_doc */ + MediumType___doc__, /* tp_doc */ 0, /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ |