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

1.7.2 #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

1.7.2 #1

wants to merge 3 commits into from

Conversation

dennis-g
Copy link

Hi Rob,

I've updated your "jquery-annotated-source" to jQuery 1.7.2. Maybe you can take it as your new master and update your gh-pages as well.

Regards
Dennis

@robflaherty
Copy link
Owner

AWESOME. I'll look at this later today. Thank you!

@robflaherty
Copy link
Owner

Hi Dennis,

I just started looking at this this morning. How did you generate the new docs? Running docco over each module in 1.7.2?

The challenge (and critical flaw) with this annotated source idea is that I don't know an elegant way of generating new docs when there are new jQuery releases, while still preserving the literate-programming-style comments that were previously added. Almost seems it has to be a manual process... which obviously few people will want to do. :)

Thanks
Rob

@dennis-g
Copy link
Author

Hi Rob,

yes, I did it with docco over each module. It was a manual process as I had to add the callbacks module and then rename all the other files. And I corrected comments using "/**/" and comments starting with "// #".

I'm sure there is a way to write a batch script with NodeJS which adds all the header information as well as the code for the navigation links. But I'm not that familiar with Node - yet. I'll think about it how to do it. Then it would be much easier to keep it up to date. Or I will write a script in PHP to prepare the source files and then run docco manually.

Dennis

@robflaherty
Copy link
Owner

Hey,

Thinking about this some more, I think there should be a grunt.js script that generates the docs. I've started on it and I don't think it'll be too difficult. It'll make it easy to keep up with new jQuery releases.

It just means that the project will be different from what I originally intended, which was to augment the jQuery source comments with manually-added descriptive comments.

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

Successfully merging this pull request may close these issues.

2 participants