test_docstring_options.cpp revision 12037
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 2712037Sandreas.sandberg@arm.com m.def("test_overloaded1", [](int) {}, py::arg("i"), "Overload docstring"); 2812037Sandreas.sandberg@arm.com m.def("test_overloaded1", [](double) {}, py::arg("d")); 2912037Sandreas.sandberg@arm.com 3012037Sandreas.sandberg@arm.com m.def("test_overloaded2", [](int) {}, py::arg("i"), "overload docstring 1"); 3112037Sandreas.sandberg@arm.com m.def("test_overloaded2", [](double) {}, py::arg("d"), "overload docstring 2"); 3212037Sandreas.sandberg@arm.com 3312037Sandreas.sandberg@arm.com m.def("test_overloaded3", [](int) {}, py::arg("i")); 3412037Sandreas.sandberg@arm.com m.def("test_overloaded3", [](double) {}, py::arg("d"), "Overload docstr"); 3512037Sandreas.sandberg@arm.com 3611986Sandreas.sandberg@arm.com options.enable_function_signatures(); 3711986Sandreas.sandberg@arm.com 3811986Sandreas.sandberg@arm.com m.def("test_function3", [](int, int) {}, py::arg("a"), py::arg("b")); 3911986Sandreas.sandberg@arm.com m.def("test_function4", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 4011986Sandreas.sandberg@arm.com 4111986Sandreas.sandberg@arm.com options.disable_function_signatures().disable_user_defined_docstrings(); 4211986Sandreas.sandberg@arm.com 4311986Sandreas.sandberg@arm.com m.def("test_function5", [](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 nested_options; 4711986Sandreas.sandberg@arm.com nested_options.enable_user_defined_docstrings(); 4811986Sandreas.sandberg@arm.com m.def("test_function6", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 4911986Sandreas.sandberg@arm.com } 5011986Sandreas.sandberg@arm.com } 5111986Sandreas.sandberg@arm.com 5211986Sandreas.sandberg@arm.com m.def("test_function7", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 5311986Sandreas.sandberg@arm.com 5411986Sandreas.sandberg@arm.com { 5511986Sandreas.sandberg@arm.com py::options options; 5611986Sandreas.sandberg@arm.com options.disable_user_defined_docstrings(); 5711986Sandreas.sandberg@arm.com 5811986Sandreas.sandberg@arm.com py::class_<DocstringTestFoo>(m, "DocstringTestFoo", "This is a class docstring") 5911986Sandreas.sandberg@arm.com .def_property("value_prop", &DocstringTestFoo::getValue, &DocstringTestFoo::setValue, "This is a property docstring") 6011986Sandreas.sandberg@arm.com ; 6111986Sandreas.sandberg@arm.com } 6211986Sandreas.sandberg@arm.com}); 63