Changes between Version 1 and Version 2 of MarkupConventions

Timestamp:

07/17/10 05:36:11 (3 years ago)

Author:

MtnViewMark (IP: 198.144.208.18)

Comment:

--

MarkupConventions

@@ -46 +46 @@
 Expected general formatting:
 
-* constructors - shown side-by-side w/doc
-** fields   - shown side-by-side w/doc
-** GADT args- shown side-by-side w/doc (does this exist?)
-* methods      - shown stacked w/doc
-** args     - shown side-by-side w/doc (?)
-* associated types - shown stacked w/doc
-** args     - shown side-by-side w/doc (?)
-* args         - shown side-by-side w/doc
-* instances    - shown side-by-side w/doc (in classes)
-* instances    - just a list (no doc for types)
+ * constructors - shown side-by-side w/doc
+ ** fields   - shown side-by-side w/doc
+ ** GADT args- shown side-by-side w/doc (does this exist?)
+ * methods      - shown stacked w/doc
+ ** args     - shown side-by-side w/doc (?)
+ * associated types - shown stacked w/doc
+ ** args     - shown side-by-side w/doc (?)
+ * args         - shown side-by-side w/doc
+ * instances    - shown side-by-side w/doc (in classes)
+ * instances    - just a list (no doc for types)
                 
 {{{        
@@ -73 +73 @@
 == basic structure ==
 
-* `div#xxx`     -- major page divs only
-* `p.caption`   -- fixed header for some page sections & the name of the module (in .module-header)
-* `h1`, `h2`...   -- interface's organization only
+ * `div#xxx`     -- major page divs only
+ * `p.caption`   -- fixed header for some page sections & the name of the module (in .module-header)
+ * `h1`, `h2`...   -- interface's organization only
 
 == formatting ==
 
-* `.src`        -- declaration source - for source code styling applied to `li`, `p`, and `dt`, such source is *not* part of documentation
+ * `.src`        -- declaration source - for source code styling applied to `li`, `p`, and `dt`, such source is *not* part of documentation
 
 == documentation ==
 
-* `p`
-* `ul`
-* `ol`
-* `pre`         -- for blocks of preformatted code
-* `code`        -- for inline source code
-* `a`           -- both in-line and external links
+ * `p`
+ * `ul`
+ * `ol`
+ * `pre`         -- for blocks of preformatted code
+ * `code`        -- for inline source code
+ * `a`           -- both in-line and external links
 
 these are all "unadorned" by classes, or wrappers
@@ -96 +96 @@
 == declaration structures ==
 
-* `.short`- an element containing a single, "short" declaration, used in `#synopsis` and in mini-pages
-* `.top` - an element containing a single, top level declaration & its doc, used in `#interface`
-* `.subs` - an element containing multiple, sub-declaration parts of a decl
-* `.arguments`, `.constructors`, `.methods`, `.instances`, `.associated-types`    -- various kinds of `.subs`
+ * `.short`- an element containing a single, "short" declaration, used in `#synopsis` and in mini-pages
+ * `.top` - an element containing a single, top level declaration & its doc, used in `#interface`
+ * `.subs` - an element containing multiple, sub-declaration parts of a decl
+ * `.arguments`, `.constructors`, `.methods`, `.instances`, `.associated-types`    -- various kinds of `.subs`