-
Notifications
You must be signed in to change notification settings - Fork 136
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
Comments
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. |
The Doxygen thing makes sense, your output seems to be quite custom for what you’re looking for. If only GitHub allowed for linkage beyond line numbers, such as function definitions!
Thank you, by the way, it’ll be a big help to utilize a great library more. ;)
- Vinyl Darkscratch-Kazotetsu, Founder of Nightwave Studios
(Sent from my Nightinfection, my iPhone)
…--
If you believe you have received this email in error, please contact me at [email protected], Twitter @vdscratchy, or Skype at vinyldarkscratch
On Jun 30, 2017, at 17:48, Craig Stuart Sapp ***@***.***> wrote:
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.
―
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.
|
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 😜 |
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?
The text was updated successfully, but these errors were encountered: