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 1212391Sjason@lowepower.comTEST_SUBMODULE(docstring_options, m) { 1312391Sjason@lowepower.com // test_docstring_options 1411986Sandreas.sandberg@arm.com { 1511986Sandreas.sandberg@arm.com py::options options; 1611986Sandreas.sandberg@arm.com options.disable_function_signatures(); 1711986Sandreas.sandberg@arm.com 1811986Sandreas.sandberg@arm.com m.def("test_function1", [](int, int) {}, py::arg("a"), py::arg("b")); 1911986Sandreas.sandberg@arm.com m.def("test_function2", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 2011986Sandreas.sandberg@arm.com 2112037Sandreas.sandberg@arm.com m.def("test_overloaded1", [](int) {}, py::arg("i"), "Overload docstring"); 2212037Sandreas.sandberg@arm.com m.def("test_overloaded1", [](double) {}, py::arg("d")); 2312037Sandreas.sandberg@arm.com 2412037Sandreas.sandberg@arm.com m.def("test_overloaded2", [](int) {}, py::arg("i"), "overload docstring 1"); 2512037Sandreas.sandberg@arm.com m.def("test_overloaded2", [](double) {}, py::arg("d"), "overload docstring 2"); 2612037Sandreas.sandberg@arm.com 2712037Sandreas.sandberg@arm.com m.def("test_overloaded3", [](int) {}, py::arg("i")); 2812037Sandreas.sandberg@arm.com m.def("test_overloaded3", [](double) {}, py::arg("d"), "Overload docstr"); 2912037Sandreas.sandberg@arm.com 3011986Sandreas.sandberg@arm.com options.enable_function_signatures(); 3111986Sandreas.sandberg@arm.com 3211986Sandreas.sandberg@arm.com m.def("test_function3", [](int, int) {}, py::arg("a"), py::arg("b")); 3311986Sandreas.sandberg@arm.com m.def("test_function4", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 3411986Sandreas.sandberg@arm.com 3511986Sandreas.sandberg@arm.com options.disable_function_signatures().disable_user_defined_docstrings(); 3611986Sandreas.sandberg@arm.com 3711986Sandreas.sandberg@arm.com m.def("test_function5", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 3811986Sandreas.sandberg@arm.com 3911986Sandreas.sandberg@arm.com { 4011986Sandreas.sandberg@arm.com py::options nested_options; 4111986Sandreas.sandberg@arm.com nested_options.enable_user_defined_docstrings(); 4211986Sandreas.sandberg@arm.com m.def("test_function6", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 4311986Sandreas.sandberg@arm.com } 4411986Sandreas.sandberg@arm.com } 4511986Sandreas.sandberg@arm.com 4611986Sandreas.sandberg@arm.com m.def("test_function7", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); 4711986Sandreas.sandberg@arm.com 4811986Sandreas.sandberg@arm.com { 4911986Sandreas.sandberg@arm.com py::options options; 5011986Sandreas.sandberg@arm.com options.disable_user_defined_docstrings(); 5111986Sandreas.sandberg@arm.com 5212391Sjason@lowepower.com struct DocstringTestFoo { 5312391Sjason@lowepower.com int value; 5412391Sjason@lowepower.com void setValue(int v) { value = v; } 5512391Sjason@lowepower.com int getValue() const { return value; } 5612391Sjason@lowepower.com }; 5711986Sandreas.sandberg@arm.com py::class_<DocstringTestFoo>(m, "DocstringTestFoo", "This is a class docstring") 5811986Sandreas.sandberg@arm.com .def_property("value_prop", &DocstringTestFoo::getValue, &DocstringTestFoo::setValue, "This is a property docstring") 5911986Sandreas.sandberg@arm.com ; 6011986Sandreas.sandberg@arm.com } 6112391Sjason@lowepower.com} 62