Skip to content

Doxygen based documentation#2233

Merged
alecjacobson merged 13 commits intomainfrom
alecjacobson/doxygen
Aug 16, 2023
Merged

Doxygen based documentation#2233
alecjacobson merged 13 commits intomainfrom
alecjacobson/doxygen

Conversation

@alecjacobson
Copy link
Copy Markdown
Contributor

@alecjacobson alecjacobson commented Aug 16, 2023

This touches almost every header file. Converts our old (albeit more legible) commenting style:

// Inputs:
//    V  #V by 3 list of mesh vertex positions
//    F  #F by 3 list of mesh face indices into rows of V
// Outputs:
//    L  #V by #V cotangent matrix

Into doxygen machine parsable comments

/// @param[in] V  #V by 3 list of mesh vertex positions
/// @param[in] F  #F by 3 list of mesh face indices into rows of V
/// @param[out] L  #V by #V cotangent matrix

The documentation is live at https://libigl.github.io/dox/index.html and current pulled in by the https://github.com/libigl/libigl.github.io repo's github action from this branch.

The styling and landing pages could use some love, but this should be enough to get us started.

@jdumas
Copy link
Copy Markdown
Collaborator

jdumas commented Aug 16, 2023

Oh wow, I never thought I'd see doxygen comments in libigl. What prompted you to make such a change? :D

@alecjacobson alecjacobson merged commit 2cc372f into main Aug 16, 2023
@alecjacobson alecjacobson deleted the alecjacobson/doxygen branch August 16, 2023 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alecjacobson @jdumas