Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document common definitions #33

Closed
vitaut opened this issue Feb 6, 2015 · 5 comments
Closed

Document common definitions #33

vitaut opened this issue Feb 6, 2015 · 5 comments

Comments

@vitaut
Copy link
Contributor

vitaut commented Feb 6, 2015

The documentation at http://ampl.github.io/common.html needs to be completed.

@vitaut
Copy link
Contributor Author

vitaut commented Feb 23, 2015

Need to do something about \rst/\endrst first as they add to much noise.

@vitaut
Copy link
Contributor Author

vitaut commented Feb 26, 2015

Also using :cpp:any: with defaultrole should make references much shorter.

@vitaut vitaut modified the milestone: 2.0 Mar 20, 2015
@vitaut
Copy link
Contributor Author

vitaut commented Mar 25, 2015

What needs to be documented:

mp/nl.h:86: warning: Compound mp::BinaryReadError is not documented.
mp/nl.h:68: warning: Compound mp::ReadError is not documented.
mp/common.h:396: warning: Compound mp::expr::OpCodeInfo is not documented.
mp/nl.h:233: warning: Member operator<<(fmt::Writer &w, const NLHeader &h) (function) of namespace mp is not documented.
mp/common.h:687: warning: Member num_common_exprs_in_both (variable) of class mp::ProblemInfo is not documented.
mp/common.h:688: warning: Member num_common_exprs_in_cons (variable) of class mp::ProblemInfo is not documented.
mp/common.h:689: warning: Member num_common_exprs_in_objs (variable) of class mp::ProblemInfo is not documented.
mp/nl.h:75: warning: Member ReadError(fmt::StringRef filename, int line, int column, fmt::StringRef message) (function) of class mp::ReadError is not documented.
mp/nl.h:80: warning: Member filename() const  (function) of class mp::ReadError is not documented.
mp/nl.h:81: warning: Member line() const  (function) of class mp::ReadError is not documented.
mp/nl.h:82: warning: Member column() const  (function) of class mp::ReadError is not documented.
mp/nl.h:92: warning: Member BinaryReadError(fmt::StringRef filename, std::size_t offset, fmt::StringRef message) (function) of class mp::BinaryReadError is not documented.
mp/nl.h:97: warning: Member filename() const  (function) of class mp::BinaryReadError is not documented.
mp/nl.h:98: warning: Member offset() const  (function) of class mp::BinaryReadError is not documented.
mp/common.h:687: warning: Member num_common_exprs_in_both (variable) of class mp::ProblemInfo is not documented.
mp/common.h:688: warning: Member num_common_exprs_in_cons (variable) of class mp::ProblemInfo is not documented.
mp/common.h:689: warning: Member num_common_exprs_in_objs (variable) of class mp::ProblemInfo is not documented.
mp/common.h:407: warning: Member GetOpCodeInfo(int opcode) (function) of namespace mp::expr is not documented.
mp/common.h:412: warning: Member opcode(expr::Kind kind) (function) of namespace mp::expr is not documented.
mp/common.h:418: warning: Member str(expr::Kind kind) (function) of namespace mp::expr is not documented.
mp/common.h:401: warning: Member kind (variable) of class mp::expr::OpCodeInfo is not documented.
mp/common.h:402: warning: Member first_kind (variable) of class mp::expr::OpCodeInfo is not documented.
mp/common.h:404: warning: Member GetOpCodeInfo(int opcode) (friend) of class mp::expr::OpCodeInfo is not documented.

@vitaut
Copy link
Contributor Author

vitaut commented Feb 11, 2016

Remaining warnings:

common.h:656: warning: Compound mp::expr::OpCodeInfo is not documented.
common.h:40: warning: Member GetOpCodeInfo(int opcode) (function) of namespace mp::expr is not documented.
common.h:40: warning: Member opcode(expr::Kind kind) (function) of namespace mp::expr is not documented.
common.h:656: warning: Member kind (variable) of class mp::expr::OpCodeInfo is not documented.
common.h:656: warning: Member first_kind (variable) of class mp::expr::OpCodeInfo is not documented.
common.h:656: warning: Member GetOpCodeInfo(int opcode) (friend) of class mp::expr::OpCodeInfo is not documented.

@vitaut
Copy link
Contributor Author

vitaut commented Feb 13, 2016

All expression kinds are documented as of fd16dd5.

@vitaut vitaut closed this as completed Feb 18, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant