Add some documentation to calendar code

VERIFIED FIXED in 1.0b1

Status

Calendar
General
VERIFIED FIXED
9 years ago
8 years ago

People

(Reporter: Fallen, Assigned: Fallen)

Tracking

unspecified
1.0b1

Details

Attachments

(3 attachments, 2 obsolete attachments)

(Assignee)

Description

9 years ago
Created attachment 355583 [details] [diff] [review]
Fix - v1
Attachment #355583 - Flags: review?(daniel.boelzle)
(Assignee)

Comment 1

9 years ago
Created attachment 355657 [details] [diff] [review]
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.
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+
(Assignee)

Comment 3

9 years ago
Created attachment 356345 [details] [diff] [review]
[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.
Attachment #355657 - Attachment is obsolete: true
Attachment #356345 - Flags: review+
(Assignee)

Comment 4

9 years ago
Created attachment 356942 [details] [diff] [review]
[checked in] Second batch of documentation




Pushed to comm-central: <http://hg.mozilla.org/comm-central/rev/1a6a0499ede4>
Attachment #356942 - Flags: review+

Comment 5

9 years ago
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
(Assignee)

Comment 6

9 years ago
Thanks for catching them, it seems I had the spellchecker off for those files. Pushed as rev 7da95ace67c3
(Assignee)

Comment 7

9 years ago
Created attachment 357776 [details] [diff] [review]
[checked in] Third batch of documentation
Attachment #357776 - Flags: review+
(Assignee)

Comment 8

9 years ago
batch 3 pushed to comm-central <http://hg.mozilla.org/comm-central/rev/84e9c5177712>
Target Milestone: --- → 1.0

Comment 9

9 years ago
I saw that the last patch contained fixes for Bug 397888 too, adding dependency.
Blocks: 397888
(Assignee)

Comment 10

9 years ago
Closing this bug for now, will open a new bug for further docs.
Status: ASSIGNED → RESOLVED
Last Resolved: 9 years ago
Resolution: --- → FIXED
Status: RESOLVED → VERIFIED
(Assignee)

Updated

8 years ago
Target Milestone: 1.0 → 1.0b1
You need to log in before you can comment on or make changes to this bug.