Skip to content

Commit 44dac41

Browse files
committed
Gadgets/Stdrev: Improve comments
1 parent 0644045 commit 44dac41

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

gadgets/standard_revisions.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Copyright (C) 2013 Povilas Kanapickas <povilas@radix.lt>
2+
Copyright (C) 2013-2014 Povilas Kanapickas <povilas@radix.lt>
33
44
This file is part of cppreference.com
55
@@ -288,7 +288,7 @@ $(function() {
288288
use when the object is shown.
289289
290290
Returns the id of the new object.
291-
*/
291+
*/
292292
this.add_object = function(obj, revs, display) {
293293
var id = this.all_objects.length;
294294
this.all_objects[id] = obj;
@@ -425,10 +425,10 @@ $(function() {
425425
}
426426
};
427427

428-
/** rev list template can be perpared separately from everything else.
428+
/** rev list template can be prepared separately from everything else.
429429
Additionally, we don't need to copy any parts of the object tree:
430-
the table rev list is contained within can be styled to appear as
431-
if it isn't there.
430+
the elements within table rev list just need to be hidder or shown
431+
depending on the revision
432432
*/
433433
this.prepare_revs = function() {
434434
this.rev_tables = $('.t-rev-begin');
@@ -630,6 +630,11 @@ $(function() {
630630

631631
// Get the mapping between revisions and function version numbers
632632

633+
/* Get the mapping between revisions and function version numbers.
634+
The function returns an array:
635+
636+
array[revision][source version number] -> version number to display
637+
*/
633638
function get_num_map() {
634639
var num_map = [];
635640

0 commit comments

Comments
 (0)