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

[DOC] Add documentation to our classes and structs. #70

Open
5 tasks
Irallia opened this issue Feb 18, 2021 · 0 comments
Open
5 tasks

[DOC] Add documentation to our classes and structs. #70

Irallia opened this issue Feb 18, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Irallia
Copy link
Collaborator

Irallia commented Feb 18, 2021

As correctly noted in review post #68 (review), all member variables and functions still lack any documentation.
This concerns:

  • aligned_segment.hpp
  • breakend.hpp
  • cluster.hpp
  • junction.hpp
  • variant_record.hpp

A documentation could look like

//! \brief Start positon of the alignment.
int32_t pos;

...

/*! \brief Position associated with this AlignedSegment.
 *
 * \return The position stored as int32_t
 */
int32_t get_reference_start() const;
@Irallia Irallia added the documentation Improvements or additions to documentation label Feb 18, 2021
@eldariont eldariont self-assigned this Feb 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants