My original intention was that after school I would write inline documentation for WordPress, while going back over old patches I made and update them for 2.6. The problem I see with that is I might be spending more time trying to get the patches in to the core then I would be writing inline documentation.
I believe that if I succeed with my intention that all of the wp-includes will be documented for WordPress 2.6. Which will be great, but I also plan on having repositories for creating patches for the 2.5 branch and for the 2.3 branch for the inline documentation. At some point I’ll create a patch which documents all of the files for the 2.0 branch, but I’m still undecided.
- Tuesday, the 13th of May
- Update current trunk repository and fix any conflicts.
- Create two new repositories for the 2.5 and 2.3 branches.
- If time, start fixing known documentation issues and go over current documentation in all files.
- Wednesday, the 14th of May
Fix known documentation issues and go over current documentation in all files.
- Thursday, the 15th of May
Document user.php, and start query.php documentation in the wp-includes folder.
- Friday, the 16th of May
I have surgery this day, so I might be a little out of it, but if I’m semi aware of my surroundings and feel up for it, I will try to document cron.php and finish documentation for wpdb.php. Also, if during the check over the old files, if any previously completed files have undocumented functions, then to document them also.
- Saturday, the 17th of May
Depending on the pain, I’ll document category.php and start comment.php.
- Sunday, the 18th of May
Finish both query.php and comment.php documentation.
- Monday, the 19th of May
Start functions.php documentation.
- Tuesday, the 20th of May
Continue working on functions.php documentation.
- Wednesday, the 21th of May
Finish functions.php documentation.
- Thursday, the 22th of May
Finish post.php documentation.
- Friday, the 23th of May
Start formatting.php documentation.
- Saturday, the 24th of May
Continue working on formatting.php documentation.
- Sunday, the 25th of May
Finish working on formatting.php documentation and functions.php, if there are still functions to document.
- Monday, the 26th of May
Create file level documentation for all base directory files describing the intention of those files, as well as all other php files. Document shortcodes.php as well.
Files that will hopefully be documented
- user.php
- query.php
- cron.php
- wp-db.php
- category.php
- comment.php
- functions.php
- post.php
- formatting.php
- shortcodes.php
Files that will be left to document
These files I plan on documenting on the weekend during the Google Summer of Code, depending on when it starts. If it starts later than the 26th of May, then I plan on continuing documenting files on this list.
- capabilities.php
- category-template.php
- classes.php
- feed.php
- general-template.php
- link-template.php
- post-template.php
- script-loader.php
- theme.php
- widgets.php
Planning is never perfect
If I can fully document functions.php and formatting.php, then I think I would have done a good job during this 13 days. Those two files take up a major portion of the total WordPress library and getting them out of the way will allow for quicker turn over for some of the files with less functions in them.
My plans on to work on this roadmap and if I have extra time to pull from some of the files with less functions in them. I believe I can document 13 functions for every 5 hours, so some of the files will overlap on some days, but I’ll probably be able to get out two files in one day.
Out of the list that needs to be completed, I won’t be documenting classes.php and widgets until the very end. I’ll focus on the files which have a short list of functions to document. That way, the list will be down to about three or four files which have a longer list of functions to document.
WordPress Admin Includes directory
Once the wp-includes folder is completed, the wp-admin/includes directory needs to be documented. This directory has a shorter list of files and functions, so it won’t take as long. However, I’m not going to focus on it, until after all of the files in wp-includes is finished.
What happened to documenting everything
Truthfully, I’m trying to document all of the files, but reality probably won’t prevent me. I’ll be lucky to complete the files on the list, but I’m going to at least try.
Possibly Related Posts:
- Calibre Improvements
- DragonU Bug Tracker Dev – Milestone 1
- Dragon MVC
- Why I Contributed to WordPress
- DragonU DB Component