From e4aa77dc3fe90bf82f7e0004995d9a5a4634993c Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Tue, 28 Aug 2012 16:08:28 -0700 Subject: [PATCH] Fix titles in API docs (via new Panino) --- api/ace.html | 2 +- api/anchor.html | 2 +- api/background_tokenizer.html | 2 +- api/command_manager.html | 13 +++++++++++++ api/document.html | 2 +- api/edit_session.html | 2 +- api/editor.html | 2 +- api/placeholder.html | 2 +- api/range.html | 2 +- api/renderloop.html | 12 ++++++++++++ api/scrollbar.html | 2 +- api/search.html | 2 +- api/selection.html | 2 +- api/split.html | 2 +- api/token_iterator.html | 2 +- api/tokenizer.html | 2 +- api/undomanager.html | 2 +- api/virtual_renderer.html | 2 +- doc/README.md | 13 +------------ doc/package.json | 3 ++- doc/resources/common_layout.jade | 2 +- 21 files changed, 45 insertions(+), 30 deletions(-) create mode 100644 api/command_manager.html create mode 100644 api/renderloop.html diff --git a/api/ace.html b/api/ace.html index 81894630..ec6b6008 100644 --- a/api/ace.html +++ b/api/ace.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/ace.js

Ace[edit]

The main class required to set up an Ace instance in the browser.

+ Ace - Ace API

Ace[edit]

The main class required to set up an Ace instance in the browser.

Methods

This method embeds the Ace editor into the DOM, at the element provided by el.

This method embeds the Ace editor into the DOM, at the element provided by el.

   

Arguments

elString | DOMElementRequired. Either the id of an element, or the element itself
diff --git a/api/anchor.html b/api/anchor.html index 04534c58..f0c6ddb6 100644 --- a/api/anchor.html +++ b/api/anchor.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/anchor.js

Anchor[edit]

Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated

+ Anchor - Ace API

Anchor[edit]

Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated

Constructors

Creates a new Anchor and associates it with a document.

Creates a new Anchor and associates it with a document.

   

Arguments

docDocumentRequired. The document to associate with the anchor
rowNumberRequired. The starting row position
columnNumberRequired. The starting column position

Events

    • Anchor.on("change", function(Event e))

    Fires whenever the anchor position changes. Events that can trigger this function include 'insertText', 'insertLines', 'removeText', and 'removeLines'.

    diff --git a/api/background_tokenizer.html b/api/background_tokenizer.html index c2854c97..a99b9030 100644 --- a/api/background_tokenizer.html +++ b/api/background_tokenizer.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/background_tokenizer.js

    BackgroundTokenizer[edit]

    Tokenizes the current Document in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.

    + BackgroundTokenizer - Ace API

    BackgroundTokenizer[edit]

    Tokenizes the current Document in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.

    Constructors

    Creates a new BackgroundTokenizer object.

    Creates a new BackgroundTokenizer object.

       

    Arguments

    tokenizerTokenizerRequired. The tokenizer to use
    editorEditorRequired. The editor to associate with

    Methods

      • BackgroundTokenizer.fireUpdateEvent(Number firstRow, Number lastRow)

      Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated.

      diff --git a/api/command_manager.html b/api/command_manager.html new file mode 100644 index 00000000..38d97f4b --- /dev/null +++ b/api/command_manager.html @@ -0,0 +1,13 @@ + + + + CommandManager - Ace API

      CommandManager[edit]

      Constructors

      TODO

      +

      TODO

      +

         

      Arguments

      platformStringRequired. Identifier for the platform; must be either 'mac' or 'win'
      commandsArrayRequired. A list of commands
      + + + + + \ No newline at end of file diff --git a/api/document.html b/api/document.html index 45b9e615..d854246e 100644 --- a/api/document.html +++ b/api/document.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/document.js

      Document[edit]

      Contains the text of the document. Document can be attached to several EditSessions. At its core, Documents are just an array of strings, with each row in the document matching up to the array index.

      + Document - Ace API

      Document[edit]

      Contains the text of the document. Document can be attached to several EditSessions. At its core, Documents are just an array of strings, with each row in the document matching up to the array index.

      Constructors

      Creates a new Document. If text is included, the Document contains those strings; otherwise, it's empty.

      Creates a new Document. If text is included, the Document contains those strings; otherwise, it's empty.

         

      Arguments

      textString | ArrayRequired. The starting text

      Methods

        • Document.$clipPosition(position)
        • Internal

         

        • Document.$detectNewLine(text)
          • Void
        • Internal

         

      Splits a string of text on any newline (\n) or carriage-return ('\r') characters.

      diff --git a/api/edit_session.html b/api/edit_session.html index 9ab62051..8719015a 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/edit_session.js

      EditSession[edit]

      Stores all the data about Editor state providing easy way to change editors state. EditSession can be attached to only one Document. Same Document can be attached to several EditSessions.

      + EditSession - Ace API

      EditSession[edit]

      Stores all the data about Editor state providing easy way to change editors state. EditSession can be attached to only one Document. Same Document can be attached to several EditSessions.

      Constructors

      Sets up a new EditSession and associates it with the given Document and TextMode.

      Sets up a new EditSession and associates it with the given Document and TextMode.

         

      Arguments

      textDocument | StringRequired. If text is a Document, it associates the EditSession with it. Otherwise, a new Document is created, with the initial text
      modeTextModeRequired. The inital language mode to use for the document

      Events

        • EditSession.on("change", function(e))

        Emitted when the document changes.

        diff --git a/api/editor.html b/api/editor.html index e739b794..469f7d21 100644 --- a/api/editor.html +++ b/api/editor.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/editor.js

        Editor[edit]

        The main entry point into the Ace functionality. The Editor manages the EditSession (which manages Documents), as well as the VirtualRenderer, which draws everything to the screen. Event sessions dealing with the mouse and keyboard are bubbled up from Document to the Editor, which decides what to do with them.

        + Editor - Ace API

        Editor[edit]

        The main entry point into the Ace functionality. The Editor manages the EditSession (which manages Documents), as well as the VirtualRenderer, which draws everything to the screen. Event sessions dealing with the mouse and keyboard are bubbled up from Document to the Editor, which decides what to do with them.

        Constructors

        Creates a new Editor object.

        Creates a new Editor object.

           

        Arguments

        rendererVirtualRendererRequired. Associated VirtualRenderer that draws everything
        sessionEditSessionRequired. The EditSession to refer to

        Events

          • Editor.on("blur", function())

          Emitted once the editor has been blurred.

          diff --git a/api/placeholder.html b/api/placeholder.html index 6d0ce9ab..e28404c8 100644 --- a/api/placeholder.html +++ b/api/placeholder.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/placeholder.js

          PlaceHolder[edit]

          TODO

          + PlaceHolder - Ace API

          PlaceHolder[edit]

          TODO

          Constructors

          Events

            • PlaceHolder.on("onCursorChange", function(e))

            Emitted when the cursor changes.

            diff --git a/api/range.html b/api/range.html index 9e864f43..d9b83ba5 100644 --- a/api/range.html +++ b/api/range.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/range.js

            Range[edit]

            This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.

            + Range - Ace API

            Range[edit]

            This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.

            Constructors

            Creates a new Range object with the given starting and ending row and column points.

            Creates a new Range object with the given starting and ending row and column points.

               

            Arguments

            startRowNumberRequired. The starting row
            startColumnNumberRequired. The starting column
            endRowNumberRequired. The ending row
            endColumnNumberRequired. The ending column

            Methods

            Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new Range object.

            diff --git a/api/renderloop.html b/api/renderloop.html new file mode 100644 index 00000000..3beaefdb --- /dev/null +++ b/api/renderloop.html @@ -0,0 +1,12 @@ + + + + RenderLoop - Ace API

            RenderLoop[edit]

            Batches changes (that force something to be redrawn) in the background.

            +

            Constructors

              • RenderLoop.new(onRender, win)
              • Internal

               

            Methods

              • RenderLoop.schedule(Array change)
              • Internal

               

            Arguments

            changeArrayRequired.
            + + + + + \ No newline at end of file diff --git a/api/scrollbar.html b/api/scrollbar.html index 932aed6d..c85e0569 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/scrollbar.js

            ScrollBar[edit]

            A set of methods for setting and retrieving the editor's scrollbar.

            + ScrollBar - Ace API

            ScrollBar[edit]

            A set of methods for setting and retrieving the editor's scrollbar.

            Constructors

            Creates a new ScrollBar. parent is the owner of the scroll bar.

            Creates a new ScrollBar. parent is the owner of the scroll bar.

               

            Arguments

            parentDOMElementRequired. A DOM element

            Events

              • ScrollBar.on("onScroll", function())

              Emitted when the scroll bar, well, scrolls.

              diff --git a/api/search.html b/api/search.html index 9e72f5e9..7c5662a8 100644 --- a/api/search.html +++ b/api/search.html @@ -1,7 +1,7 @@ - Ace API - /Users/gjtorikian/Developer/ace/lib/ace/search.js

              Search[edit]

              A class designed to handle all sorts of text searches within a Document.

              + Search - Ace API

              Search[edit]

              A class designed to handle all sorts of text searches within a Document.

              Constructors

                • Search.new()

                Creates a new Search object. The following search options are avaliable:

                Creates a new Search object. The following search options are avaliable: