github-migration
/
prototype
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change all H4s in _method_ documentation blocks to H5s. (Start with H5 when using headings in a method doc block; start with H4 when using headings in a namespace/class doc block.)

This commit is contained in:
Andrew Dupont 2009-09-09 23:18:45 -05:00
parent cf72372092
commit 5ccf8cbefd
5 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/dom/dom.js
View File

@ -320,7 +320,7 @@ Element.Methods = {
* - `top` (as `element`'s first child)
* - `bottom` (as `element`'s last child)
*
* <h4>Examples</h4>
* <h5>Examples</h5>
*
* Insert the given HTML at the bottom of the element (using the default):
*

20
src/dom/event.js
View File

@ -418,7 +418,7 @@
*
* The examples in this documentation use the [[Element#observe]] form.
*
* <h4>The Handler</h4>
* <h5>The Handler</h5>
*
* Signature:
*
@ -435,13 +435,13 @@
* Note that we used `this` to refer to the element, and that we received the `event` object
* as a parameter (even on MSIE).
*
* <h4>It's All About Timing</h4>
* <h5>It's All About Timing</h5>
*
* One of the most common errors trying to observe events is trying to do it before the element
* exists in the DOM. Don't try to observe elements until after the
* [[document.observe dom:loaded]] event or `window` `load` event has been fired.
*
* <h4>Preventing the Default Event Action and Bubbling</h4>
* <h5>Preventing the Default Event Action and Bubbling</h5>
*
* If we want to stop the event (e.g., prevent its default action and stop it bubbling), we can
* do so with the extended event object's [[Event#stop]] method:
@ -450,7 +450,7 @@
* event.stop();
* });
*
* <h4>Finding the Element Where the Event Occurred</h4>
* <h5>Finding the Element Where the Event Occurred</h5>
*
* Since most events bubble from descendant elements up through the hierarchy until they're
* handled, we can observe an event on a container rather than individual elements within the
@ -481,12 +481,12 @@
* record was clicked. [[Event#findElement]] finds the row that was clicked, and `this` refers
* to the table we were observing.
*
* <h4>Stopping Observing the Event</h4>
* <h5>Stopping Observing the Event</h5>
*
* If we don't need to observe the event anymore, we can stop observing it with
* [[Event.stopObserving]] (aka [[Element#stopObserving]]).
*
* <h4>Using an Instance Method as a Handler</h4>
* <h5>Using an Instance Method as a Handler</h5>
*
* If we want to use an instance method as a handler, we will probably want to use
* [[Function#bind]] to set the handler's context; otherwise, the context will be lost and
@ -511,13 +511,13 @@
* details. There's also [[Function#bindAsEventListener]], which is handy for certain very
* specific situations. (Normally, `bind` is all you need.)
*
* <h4>Side Notes</h4>
* <h5>Side Notes</h5>
*
* Although Prototype smooths out most of the differences between browsers, the fundamental
* behavior of a browser implementation isn't changed. For example, the timing of the `change`
* or `blur` events varies a bit from browser to browser.
*
* <h4>Changes in 1.6.x</h4>
* <h5>Changes in 1.6.x</h5>
*
* Prior to Prototype 1.6, `observe` supported a fourth argument (`useCapture`), a boolean that
* indicated whether to use the browser's capturing phase or its bubbling phase. Since MSIE does
@ -572,7 +572,7 @@
* for that `eventName`. If `eventName` is also omitted, unregisters _all_
* event handlers on `element`. (In each case, only affects handlers registered via Prototype.)
*
* <h4>Examples</h4>
* <h5>Examples</h5>
*
* Assuming:
*
@ -591,7 +591,7 @@
*
* $('foo').stopObserving();
*
* <h4>A Common Error</h4>
* <h5>A Common Error</h5>
*
* When using instance methods as observers, it's common to use [[Function#bind]] on them, e.g.:
*

8
src/dom/form.js
View File

@ -39,14 +39,14 @@ var Form = {
* the value for that key in the object will be an array of the field values
* in the order they appeared on the array of elements.
*
* <h4>The Options</h4>
* <h5>The Options</h5>
*
* The options allow you to control two things: What kind of return
* value you get (an object or a string), and whether and which `submit`
* fields are included in that object or string.
*
* If you do not supply an `options` object _at all_, the options
* `{hash: false}` are used.
* `{ hash: false }` are used.
*
* If you supply an `options` object, it may have the following options:
* - `hash` ([[Boolean]]): `true` to return a plain object with keys and values
@ -64,7 +64,7 @@ var Form = {
* _(Deprecated)_ If you pass in a [[Boolean]] instead of an object for `options`, it
* is used as the `hash` option and all other options are defaulted.
*
* <h4>A <em>hash</em>, not a Hash</h4>
* <h5>A <em>hash</em>, not a Hash</h5>
*
* If you opt to receive an object, it is a plain JavaScript object with keys
* and values, __not__ a [[Hash]]. All JavaScript objects are hashes in the lower-case
@ -629,7 +629,7 @@ Form.Element.EventObserver = Class.create(Abstract.EventObserver, {
});
/** section: DOM
* class Form.Element.EventObserver < Abstract.EventObserver
* class Form.EventObserver < Abstract.EventObserver
**/
Form.EventObserver = Class.create(Abstract.EventObserver, {
getValue: function() {

2
src/lang/class.js
View File

@ -86,7 +86,7 @@ var Class = (function() {
* of the class and of all its subclasses, even those that have already been
* instantiated.
*
* <h4>Examples</h4>
* <h5>Examples</h5>
*
* var Animal = Class.create({
* initialize: function(name, sound) {

12
src/lang/string.js
View File

@ -127,11 +127,11 @@ Object.extend(String.prototype, (function() {
* `span`, and `abbr`. It _will not_ strip namespace-prefixed tags such
* as `h:table` or `xsl:template`.
*
* <h4>Caveat User</h4>
* <h5>Caveat User</h5>
*
* Note that the processing `stripTags` does is good enough for most purposes, but
* you cannot rely on it for security purposes. If you're processing end-user-supplied
* content, `stripTags` is probably _not_ sufficiently robust to ensure that the content
* content, `stripTags` is _not_ sufficiently robust to ensure that the content
* is completely devoid of HTML tags in the case of a user intentionally trying to circumvent
* tag restrictions. But then, you'll be running them through [[String#escapeHTML]] anyway,
* won't you?
@ -145,12 +145,12 @@ Object.extend(String.prototype, (function() {
*
* Strips a string of things that look like an HTML script blocks.
*
* <h4>Example</h4>
* <h5>Example</h5>
*
* "<p>This is a test.<script>alert("Look, a test!");</script>End of test</p>".stripScripts();
* // => "<p>This is a test.End of test</p>"
*
* <h4>Caveat User</h4>
* <h5>Caveat User</h5>
*
* Note that the processing `stripScripts` does is good enough for most purposes,
* but you cannot rely on it for security purposes. If you're processing end-user-supplied
@ -183,7 +183,7 @@ Object.extend(String.prototype, (function() {
* they were empty (the result for that position in the array will be `undefined`);
* external files are _not_ loaded and processed by `evalScripts`.
*
* <h4>About `evalScripts`, `var`s, and defining functions</h4>
* <h5>About `evalScripts`, `var`s, and defining functions</h5>
*
* `evalScripts` evaluates script blocks, but this **does not** mean they are
* evaluated in the global scope. They aren't, they're evaluated in the scope of
@ -302,7 +302,7 @@ Object.extend(String.prototype, (function() {
* Converts a string separated by dashes into a camelCase equivalent.
* For instance, 'foo-bar' would be converted to 'fooBar'.
*
* <h4>Examples</h4>
* <h5>Examples</h5>
*
* 'background-color'.camelize();
* // -> 'backgroundColor'