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 source code links to the wrong lines #43

Open
queengooborg opened this issue Jul 1, 2017 · 3 comments
Open

Documentation source code links to the wrong lines #43

queengooborg opened this issue Jul 1, 2017 · 3 comments

Comments

@queengooborg
Copy link

The links to the source code from the documentation don't match with the source code of the current version of Midifile. I'm up for taking care of this, but might I also recommend something like Doxygen to help with documentation generation?

@craigsapp
Copy link
Owner

I'll see if I can update it this weekend. As you noticed the documentation should be regenerated when the code changes since the links to the code on Github has to be given fixed line numbers. I am lazy and just read the source code as documentation, so the website documentation tends to get out of sync...

Doxygen is in theory possible, but I have never seen doxygen output that I really like.

@queengooborg
Copy link
Author

queengooborg commented Jul 1, 2017 via email

@craigsapp
Copy link
Owner

The current problem that I am linking to the master commit code lines, but the line numbers in the source code are in reference to a fixed commit number that is older than the commit head. I will work on fixing the code linking to behave better (and I still have to update the documentation which will also fix the problem). I am lazy myself and look at the source code for documentation, so I am not noticing the problem 😜

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

2 participants