Mercurial > doc-thingy

annotate samplecode.js @ 8:f3f56cc75bfd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Code column is now colored differently.
author Atul Varma <varmaa@toolness.com>
date Mon, 05 Jan 2009 18:40:10 -0800
parents dcae71b1c3b4
children 5418d21d7751
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
1 /* ***** BEGIN LICENSE BLOCK *****
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
3 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
4 * The contents of this file are subject to the Mozilla Public License Version
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
5 * 1.1 (the "License"); you may not use this file except in compliance with
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
6 * the License. You may obtain a copy of the License at
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
7 * http://www.mozilla.org/MPL/
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
8 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
9 * Software distributed under the License is distributed on an "AS IS" basis,
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
11 * for the specific language governing rights and limitations under the
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
12 * License.
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
13 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
14 * The Original Code is Ubiquity.
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
15 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
16 * The Initial Developer of the Original Code is Mozilla.
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
17 * Portions created by the Initial Developer are Copyright (C) 2007
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
18 * the Initial Developer. All Rights Reserved.
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
19 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
20 * Contributor(s):
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
21 * Atul Varma <atul@mozilla.com>
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
22 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
23 * Alternatively, the contents of this file may be used under the terms of
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
24 * either the GNU General Public License Version 2 or later (the "GPL"), or
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
26 * in which case the provisions of the GPL or the LGPL are applicable instead
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
27 * of those above. If you wish to allow use of your version of this file only
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
28 * under the terms of either the GPL or the LGPL, and not to allow others to
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
29 * use your version of this file under the terms of the MPL, indicate your
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
30 * decision by deleting the provisions above and replace them with the notice
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
31 * and other provisions required by the GPL or the LGPL. If you do not delete
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
32 * the provisions above, a recipient may use your version of this file under
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
33 * the terms of any one of the MPL, the GPL or the LGPL.
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
34 *
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
35 * ***** END LICENSE BLOCK ***** */
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
36
5
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
37 // = Sample Code =
0
7de0c0d19f97 Origination. The narcissus code has been slightly modified from its snapshot at mozilla-central rev. 2ad9a0f79e7d to support comment tracking in the parser.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
38 //
5
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
39 // This is just a test of the Thingy documentation system.
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
40
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
41 var BEANS = 1;
4
ccc558eb70db Comments are now chunked into blocks.
Atul Varma <varmaa@toolness.com>
parents: 2
diff changeset
42
5
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
43 // == Functions ==
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
44
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
45 // ==== {{{blarg()}}} ====
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
46 //
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
47 // This function takes no parameters and returns the string
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
48 // {{{blarg}}}. It's pretty cool that way.
0
7de0c0d19f97 Origination. The narcissus code has been slightly modified from its snapshot at mozilla-central rev. 2ad9a0f79e7d to support comment tracking in the parser.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
49
7de0c0d19f97 Origination. The narcissus code has been slightly modified from its snapshot at mozilla-central rev. 2ad9a0f79e7d to support comment tracking in the parser.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
50 function blarg() {
8
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
51 var consoleService = Components.classes["@mozilla.org/consoleservice;1"]
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
52 .getService(Components.interfaces.nsIConsoleService);
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
53 var scriptError = Components.classes["@mozilla.org/scripterror;1"]
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
54 .createInstance(Components.interfaces.nsIScriptError);
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
55 var aSourceName = stackFrame.filename;
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
56 var aSourceLine = stackFrame.sourceLine;
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
57 var aLineNumber = stackFrame.lineNumber;
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
58 var aColumnNumber = null;
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
59 var aFlags = scriptError.warningFlag;
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
60 var aCategory = "ubiquity javascript";
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
61 scriptError.init(aMessage, aSourceName, aSourceLine, aLineNumber,
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
62 aColumnNumber, aFlags, aCategory);
f3f56cc75bfd Code column is now colored differently.
Atul Varma <varmaa@toolness.com>
parents: 5
diff changeset
63
5
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
64 return "blarg";
0
7de0c0d19f97 Origination. The narcissus code has been slightly modified from its snapshot at mozilla-central rev. 2ad9a0f79e7d to support comment tracking in the parser.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
65 }
5
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
66
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
67 // ==== {{{foo(x)}}} ====
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
68 //
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
69 // This function returns the parameter multiplied by 2.
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
70
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
71 function foo(x) {
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
72 return x*2;
dcae71b1c3b4 Changed sample code, removed a debug logging statement.
Atul Varma <varmaa@toolness.com>
parents: 4
diff changeset
73 }