drake FormulaCell: castxml / pygccxml marking as incomplete?
Encountered in :
https://github.com/josephsnyder/drake/pull/3
This can be found via Drake's mkdoc
; see full raw file:
https://raw.githubusercontent.com/josephsnyder/drake/32bc2657806ef6e16b41eb45322c475d187cc433/tmp/autopybind11/documentation_pybind.h
Relevant snippet:
// Symbol: drake::symbolic::FormulaCell
struct /* FormulaCell */ {
// Source: drake/common/symbolic_formula_cell.h:33
const char* doc =
R"""(Represents an abstract class which is the base of concrete
symbolic-formula classes (i.e. symbolic::FormulaAnd,
symbolic::FormulaEq).
Note:
It provides virtual function, FormulaCell::Display, because
operator<< is not allowed to be a virtual function.)""";
// Symbol: drake::symbolic::FormulaCell::Display
struct /* Display */ {
// Source: drake/common/symbolic_formula_cell.h:56
const char* doc =
R"""(Outputs string representation of formula into output stream ``os``.)""";
} Display;
// Symbol: drake::symbolic::FormulaCell::EqualTo
struct /* EqualTo */ {
// Source: drake/common/symbolic_formula_cell.h:45
const char* doc = R"""(Checks structural equality.)""";
} EqualTo;
// Symbol: drake::symbolic::FormulaCell::Evaluate
struct /* Evaluate */ {
// Source: drake/common/symbolic_formula_cell.h:49
const char* doc = R"""(Evaluates under a given environment.)""";
} Evaluate;
// Symbol: drake::symbolic::FormulaCell::FormulaCell
struct /* ctor */ {
// Source: drake/common/symbolic_formula_cell.h:59
const char* doc_0args = R"""(Default constructor (deleted).)""";
// Source: drake/common/symbolic_formula_cell.h:69
const char* doc_move =
R"""(Move-construct a formula from an rvalue.)""";
// Source: drake/common/symbolic_formula_cell.h:71
const char* doc_copy =
R"""(Copy-construct a formula from an lvalue.)""";
// Source: drake/common/symbolic_formula_cell.h:73
const char* doc_1args = R"""(Construct FormulaCell of kind ``k``.)""";
} ctor;
// Symbol: drake::symbolic::FormulaCell::GetFreeVariables
struct /* GetFreeVariables */ {
// Source: drake/common/symbolic_formula_cell.h:43
const char* doc =
R"""(Returns set of free variables in formula.)""";
} GetFreeVariables;
// Symbol: drake::symbolic::FormulaCell::HashAppendDetail
struct /* HashAppendDetail */ {
// Source: drake/common/symbolic_formula_cell.h:41
const char* doc =
R"""(Sends all hash-relevant bytes for this FormulaCell type into the given
hasher, per the hash_append concept -- except for get_kind(), because
Formula already sends that.)""";
} HashAppendDetail;
// Symbol: drake::symbolic::FormulaCell::Less
struct /* Less */ {
// Source: drake/common/symbolic_formula_cell.h:47
const char* doc = R"""(Checks ordering.)""";
} Less;
// Symbol: drake::symbolic::FormulaCell::Substitute
struct /* Substitute */ {
// Source: drake/common/symbolic_formula_cell.h:54
const char* doc =
R"""(Returns a Formula obtained by replacing all occurrences of the
variables in ``s`` in the current formula cell with the corresponding
expressions in ``s``.)""";
} Substitute;
// Symbol: drake::symbolic::FormulaCell::get_kind
struct /* get_kind */ {
// Source: drake/common/symbolic_formula_cell.h:36
const char* doc = R"""(Returns kind of formula.)""";
} get_kind;
} FormulaCell;
Edited by Eric Cousineau