472314 - Add some documentation to calendar code

Status: VERIFIED FIXED

(Calendar :: General, defect)

Description

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Attachment: Fix - v1

Comment 1

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Attachment: Fix - v2

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.

Comment 2

[Daniel Boelzle [:dbo]]

Comment on attachment 355657 [details] [diff] [review]
Fix - v2

r=dbo for this and blanket r+ for adding further documentation

Comment 3

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Attachment: [checked in] Fix - v3

Final patch of the first batch, 

Pushed to comm-central <http://hg.mozilla.org/comm-central/rev/f71460033b07>

Keeping bug open for further documentation batches.

Comment 4

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Attachment: [checked in] Second batch of documentation

Pushed to comm-central: <http://hg.mozilla.org/comm-central/rev/1a6a0499ede4>

Comment 5

[Stefan Sitter [:ssitter]]

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

Comment 6

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Thanks for catching them, it seems I had the spellchecker off for those files. Pushed as rev 7da95ace67c3

Comment 7

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Attachment: [checked in] Third batch of documentation

Comment 8

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

batch 3 pushed to comm-central <http://hg.mozilla.org/comm-central/rev/84e9c5177712>

Comment 9

[Stefan Sitter [:ssitter]]

I saw that the last patch contained fixes for Bug 397888 too, adding dependency.

Comment 10

[Philipp Preißer-Kewisch [:Fallen][☁️📆]]

Closing this bug for now, will open a new bug for further docs.