test_docstring_options.cpp revision 11986
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com tests/test_docstring_options.cpp -- generation of docstrings and signatures 311986Sandreas.sandberg@arm.com 411986Sandreas.sandberg@arm.com Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> 511986Sandreas.sandberg@arm.com 611986Sandreas.sandberg@arm.com All rights reserved. Use of this source code is governed by a 711986Sandreas.sandberg@arm.com BSD-style license that can be found in the LICENSE file. 811986Sandreas.sandberg@arm.com*/ 911986Sandreas.sandberg@arm.com 1011986Sandreas.sandberg@arm.com#include "pybind11_tests.h" 1111986Sandreas.sandberg@arm.com 1211986Sandreas.sandberg@arm.comstruct DocstringTestFoo { 1311986Sandreas.sandberg@arm.com int value; 1411986Sandreas.sandberg@arm.com void setValue(int v) { value = v; } 1511986Sandreas.sandberg@arm.com int getValue() const { return value; } 1611986Sandreas.sandberg@arm.com}; 1711986Sandreas.sandberg@arm.com 1811986Sandreas.sandberg@arm.comtest_initializer docstring_generation([](py::module &m) { 1911986Sandreas.sandberg@arm.com 2011986Sandreas.sandberg@arm.com { 2111986Sandreas.sandberg@arm.com py::options options; 2211986Sandreas.sandberg@arm.com options.disable_function_signatures(); 2311986Sandreas.sandberg@arm.com 2411986Sandreas.sandberg@arm.com m.def("test_function1", [](int, int) {}, py::arg("a"), py::arg("b")); 2511986Sandreas.sandberg@arm.com m.def("test_function2", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 2611986Sandreas.sandberg@arm.com 2711986Sandreas.sandberg@arm.com options.enable_function_signatures(); 2811986Sandreas.sandberg@arm.com 2911986Sandreas.sandberg@arm.com m.def("test_function3", [](int, int) {}, py::arg("a"), py::arg("b")); 3011986Sandreas.sandberg@arm.com m.def("test_function4", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 3111986Sandreas.sandberg@arm.com 3211986Sandreas.sandberg@arm.com options.disable_function_signatures().disable_user_defined_docstrings(); 3311986Sandreas.sandberg@arm.com 3411986Sandreas.sandberg@arm.com m.def("test_function5", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 3511986Sandreas.sandberg@arm.com 3611986Sandreas.sandberg@arm.com { 3711986Sandreas.sandberg@arm.com py::options nested_options; 3811986Sandreas.sandberg@arm.com nested_options.enable_user_defined_docstrings(); 3911986Sandreas.sandberg@arm.com m.def("test_function6", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 4011986Sandreas.sandberg@arm.com } 4111986Sandreas.sandberg@arm.com } 4211986Sandreas.sandberg@arm.com 4311986Sandreas.sandberg@arm.com m.def("test_function7", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 4411986Sandreas.sandberg@arm.com 4511986Sandreas.sandberg@arm.com { 4611986Sandreas.sandberg@arm.com py::options options; 4711986Sandreas.sandberg@arm.com options.disable_user_defined_docstrings(); 4811986Sandreas.sandberg@arm.com 4911986Sandreas.sandberg@arm.com py::class_<DocstringTestFoo>(m, "DocstringTestFoo", "This is a class docstring") 5011986Sandreas.sandberg@arm.com .def_property("value_prop", &DocstringTestFoo::getValue, &DocstringTestFoo::setValue, "This is a property docstring") 5111986Sandreas.sandberg@arm.com ; 5211986Sandreas.sandberg@arm.com } 5311986Sandreas.sandberg@arm.com}); 54