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

Fix autodoc issues wrt mesh package #524

Closed
KineticTheory opened this issue Nov 11, 2018 · 3 comments
Closed

Fix autodoc issues wrt mesh package #524

KineticTheory opened this issue Nov 11, 2018 · 3 comments
Assignees
Labels
Milestone

Comments

@KineticTheory
Copy link
Collaborator

KineticTheory commented Nov 11, 2018

Issues:

  F:/work/draco/src/mesh/Draco_Mesh.hh:161: warning: The following parameters of rtt_mesh::Draco_Mesh::compute_cell_to_cell_linkage(const std::vector< unsigned > &cell_type, const std::vector< unsigned > &cell_to_node_linkage, const std::vector< unsigned > &side_node_count, const std::vector< unsigned > &side_to_node_linkage, const std::vector< unsigned > &ghost_cell_type, const std::vector< unsigned > &ghost_cell_to_node_linkage) are not documented:
    parameter 'ghost_cell_type'
    parameter 'ghost_cell_to_node_linkage'
  F:/work/draco/src/mesh/X3D_Draco_Mesh_Reader.hh:148: warning: The following parameters of rtt_mesh::X3D_Draco_Mesh_Reader::map_x3d_block(const std::string &block_name, size_t &dist) are not documented:
    parameter 'dist'
@KineticTheory
Copy link
Collaborator Author

This isn't super high priority. Maybe address this in your next code change to the mesh package.

@RyanWollaeger
Copy link
Contributor

@KineticTheory Thank you for catching this - it will be fixed in the next changeset. It also may be possible to remove some of the arguments in the cell_to_cell linkage function.

@KineticTheory
Copy link
Collaborator Author

Fixed by #550

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants