Closed Bug 472314 Opened 11 years ago Closed 11 years ago

Add some documentation to calendar code


(Calendar :: General, defect)

Not set


(Not tracked)



(Reporter: Fallen, Assigned: Fallen)




(3 files, 2 obsolete files)

Attached patch Fix - v1 (obsolete) β€” β€” Splinter Review
No description provided.
Attachment #355583 - Flags: review?(daniel.boelzle)
Attached patch Fix - v2 (obsolete) β€” β€” Splinter Review
More documentation. You may consider giving me a blanket review (if everyone else is ok with that) to add more documentation. I can post the patches in this bug.
Attachment #355583 - Attachment is obsolete: true
Attachment #355657 - Flags: review?(daniel.boelzle)
Attachment #355583 - Flags: review?(daniel.boelzle)
Comment on attachment 355657 [details] [diff] [review]
Fix - v2

r=dbo for this and blanket r+ for adding further documentation
Attachment #355657 - Flags: review?(daniel.boelzle) → review+
Attached patch [checked in] Fix - v3 β€” β€” Splinter Review
Final patch of the first batch, 

Pushed to comm-central <>

Keeping bug open for further documentation batches.
Attachment #355657 - Attachment is obsolete: true
Attachment #356345 - Flags: review+
Nit: typos

+++ b/calendar/base/content/agenda-listbox.js
+ * Checks if the given item happens before the comparation item.

comparation -> comparison?

+++ b/calendar/base/content/dialogs/calendar-event-dialog-attendees.js
+ * XXX Function names are all very similar here. This needs some consistancy!

consistancy -> consistency

+++ b/calendar/base/content/dialogs/calendar-event-dialog-recurrence.js
+ * the dialog controls with the recurrece information for this window.

recurrece -> 

+++ b/calendar/base/content/dialogs/calendar-event-dialog.js
+ * @param menuPopup   The menupopup node targetted by the event.

targetted -> targeted

+++ b/calendar/base/content/calendar-item-editing.js
+ * @param aForceAllDay  (optioanl) Make sure the event shown in the dialog is an

optioanl -> optional

+++ b/calendar/base/content/calendar-item-editing.js
+ * @param job                   (optional) The job object that controlls this

controlls -> controls

+++ b/calendar/base/content/today-pane.js
+   * Hanlder function for the DOMAttrModified event used to observe the

Hanlder -> Handler
Thanks for catching them, it seems I had the spellchecker off for those files. Pushed as rev 7da95ace67c3
batch 3 pushed to comm-central <>
Target Milestone: --- → 1.0
I saw that the last patch contained fixes for Bug 397888 too, adding dependency.
Blocks: 397888
Closing this bug for now, will open a new bug for further docs.
Closed: 11 years ago
Resolution: --- → FIXED
Target Milestone: 1.0 → 1.0b1
You need to log in before you can comment on or make changes to this bug.