print_doc.hpp File Reference

#include <mlpack/prereqs.hpp>
#include <mlpack/core/util/hyphenate_string.hpp>
#include "get_printable_type.hpp"

Include dependency graph for print_doc.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	mlpack
	Linear algebra utility functions, generally performed on matrices or vectors.

Functions
template<typename T >
void	mlpack::bindings::python::PrintDoc (util::ParamData &d, const void *input, void *)
	Print the docstring documentation for a given parameter. More...

Detailed Description

Author

Ryan Curtin

Print documentation (as part of a docstring) for a Python binding parameter.

mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information.

Function Documentation

PrintDoc()

template<typename T >

void mlpack::bindings::python::PrintDoc	(	util::ParamData &	d,
		const void *	input,
		void *
	)

Print the docstring documentation for a given parameter.

You are responsible for setting up the line—this does not handle indentation or anything. This is meant to produce a line of documentation describing a single parameter.

The indent parameter (void* input, which should be a pointer to a size_t) should be passed to know how much to indent for a new line.

Parameters

d	Parameter data struct.
input	Pointer to size_t containing indent.
*	(output) Unused parameter.