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

Documentation #120

Open
nlw0 opened this issue Aug 24, 2016 · 5 comments
Open

Documentation #120

nlw0 opened this issue Aug 24, 2016 · 5 comments
Labels

Comments

@nlw0
Copy link
Contributor

nlw0 commented Aug 24, 2016

It would be great if the actual documentation from g2o was available somewhere. It is only possible to easily find the ICRA article here and on openslam.org...

@felixendres
Copy link
Contributor

There is a pdf document with a detailed description of how the library is structured and how to use/extend it in the folder "doc". The API documentation you can generate yourself as described in the readme in doc/doxygen

Is that what you mean by "actual documentation"?

@nlw0
Copy link
Contributor Author

nlw0 commented Aug 29, 2016

That's the one! Just wanted to suggest leaving the link explicitly at the README and maybe at the openslam.org page.

felixendres added a commit to felixendres/g2o that referenced this issue Aug 29, 2016
@NadimDeeb
Copy link

The pdf document is not available anymore, I am looking for a api documentation since a function from the g2o library is causing me trouble and I would like to see how it behaves. It's the make_function.

@felixendres
Copy link
Contributor

@NadimDeeb
Have you tried building the pdf? On the command line, go to the doc directory and execute make. Alternatively you can get an (possibly outdated) copy from an older revision, e.g. https://github.com/RainerKuemmerle/g2o/blob/20170730_git/doc/g2o.pdf

Anyway, it's not an api reference, so you'll probably not find what you are looking for.

Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the Stale label Jan 21, 2025
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

3 participants