JSDuck: Generated code documentation!
See CODING.md for how to run it.
Mistakes fixed:
* Warning: Unknown type function
-> Function
* Warning: Unknown type DOMElement
-> HTMLElement
* Warning: Unknown type DOM Node
-> HTMLElement
* Warning: Unknown type Integer
-> Mixed
* Warning: Unknown type Command
-> ve.Command
* Warning: Unknown type any
-> number
* Warning: Unknown type ve.Transaction
-> ve.dm.Transaction
* Warning: Unknown type ve.dm.AnnotationSet
-> ve.AnnotationSet
* Warning: Unknown type false
-> boolean
* Warning: Unknown type ve.dm.AlienNode
ve.dm doesn't have a generic AlienNode like ve.ce
-> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode
* Warning: Unknown type ve.ve.Surface
-> ve.ce.Surface
* ve.example.lookupNode:
-> Last @param should be @return
* ve.dm.Transaction.prototype.pushReplace:
-> @param {Array] should be @param {Array}
* Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
* Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
Differences fixed:
* Variadic arguments are like @param {Type...} [name]
instead of @param {Type} [name...]
* Convert all file headers from /** to /*! because JSDuck tries
to parse all /** blocks and fails to parse with all sorts of
errors for "Global property", "Unnamed property", and
"Duplicate property".
Find: \/\*\*([^@]+)(@copyright)
Replace: /*!$1$2
* Indented blocks are considered code examples.
A few methods had documentation with numbered lists that were
indented, which have now been updated to not be intended.
* The free-form text descriptions are parsed with Markdown,
which requires lists to be separated from paragraphs by an
empty line.
And we should use `backticks` instead of {braces} for inline
code in text paragraphs.
* Doc blocks for classes and their constructor have to be
in the correct order (@constructor, @param, @return must be
before @class, @abstract, @extends etc.)
* `@extends Class` must not have Class {wrapped}
* @throws must start with a {Type}
* @example means something else. It is used for an inline demo
iframe, not code block. For that simply indent with spaces.
* @member means something else.
Non-function properties are marked with @property, not @member.
* To create a link to a class or member, in most cases the name
is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux,
where a hash stands for "instance member", so Foo.bar#quux,
links to Foo.bar.prototype.quux (the is not supported, as
"prototype" is considered an implementation detail, it only
indexes class name and method name).
If the magic linker doesn't work for some case, the
verbose syntax is {@link #target label}.
* @property can't have sub-properties (nested @param and @return
values are supported, only @static @property can't be nested).
We only have one case of this, which can be worked around by
moving those in a new virtual class. The code is unaltered
(only moved down so that it isn't with the scope of the main
@class block). ve.dm.TransactionProcessor.processors.
New:
* @mixins: Classes mixed into the current class.
* @event: Events that can be emitted by a class. These are also
inherited by subclasses. (+ @param, @return and @preventable).
So ve.Node#event-attach is inherited to ve.dm.BreakNode,
just like @method is.
* @singleton: Plain objects such as ve, ve.dm, ve.ce were missing
documentation causing a tree error. Documented those as a
JSDuck singleton, which they but just weren't documented yet.
NB: Members of @singleton don't need @static (if present,
triggers a compiler warning).
* @chainable: Shorthand for "@return this". We were using
"@return {classname}" which is ambiguous (returns the same
instance or another instance?), @chainable is specifically
for "@return this". Creates proper labels in the generated
HTML pages.
Removed:
* @mixin: (not to be confused with @mixins). Not supported by
JSDuck. Every class is standalone anyway. Where needed marked
them @class + @abstract instead.
Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
|
|
|
/*!
|
2013-01-15 23:38:49 +00:00
|
|
|
* VisualEditor MediaWiki Initialization ViewPageTarget Vector skin styles.
|
2012-08-17 20:16:25 +00:00
|
|
|
*
|
2014-01-05 12:05:05 +00:00
|
|
|
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
|
2012-08-17 20:16:25 +00:00
|
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
|
|
|
*/
|
|
|
|
|
|
Transplant CSS from the main document to each iframe
We previously manually loaded CSS into these frames, which is flawed
because it completely bypasses ResourceLoader (so CSSJanus didn't flip
them, necessitating a bunch of hacks for RTL), and doesn't pull in
MediaWiki styles (so templates inside references don't render correctly).
Instead, this commit copies all styles from the main document into each
frame's document, inlining what it can.
Loading all styles in dialogs and inspectors caused some problems,
initially. We didn't namespace our styles for dialogs vs. inspectors
at all; the only reason inspector styles weren't being applied to dialogs
and vice versa was because we controlled which files were being loaded
in which context. This commit namespaces the inspector and dialog styles
where needed so they don't conflict and try to override each other.
Tested in Vector and Monobook, but not in Apex and not in RTL.
ve.init.mw.ViewPageTarget*.css:
* Namespace styles that are only intended for the main document
* Undo Monobook's font-size: x-small; in frames
*Dialog.js:
* Remove addLocalStylesheet() calls, we don't need those any more
** ve.ui.MWDialog seems to be unneeded now, we may want to remove it
*.css:
* Remove @noflip-ped RTL rules where they were just flipped versions of
their LTR counterparts
ve.ui.Dialog.css, ve.ui.Inspector.css:
* Namespace styles with .ve-ui-dialog-content / .ve-ui-inspector-content
ve.ui.Frame.css:
* Move the margin:0 and padding:0 here (were in the frame <body>'s style
attribute) and add background:none to prevent frames from getting
the skin's background (grey in Vector, a book in Monobook)
ve.ui.Dialog.js, ve.ui.Inspector.js:
* Add ve-ui-dialog-content / ve-ui-inspector-content class to the
frame's content <div> so we can restrict styles to only apply in
dialogs / inspectors
ve.ui.Frame.js:
* Replace infrastructure for @import-ing stylesheets with transplantation
* Remove code polling to see when the stylesheets were loaded
** We can't do this in the new approach AFAIK, since all styles in the
frame are either inlined or inaccessible due to the same-origin policy
** We also shouldn't need it because the browser should have cached the
styles when it loaded the main document
* Apply ve-ui-frame-body class to the frame's <body> so we can style it
** Move inline padding:0;margin:0; into ve.ui.Frame.css
** Move the ve-ltr/ve-rtl class up to the <body>
ve.ui.Window.js:
* Remove infrastructure registering stylesheet URLs to load
Change-Id: I4a37115301811ad860f4578344a04873ea8c2b69
2013-07-03 21:47:52 +00:00
|
|
|
.ve-init-mw-viewPageTarget-surface {
|
2014-04-24 20:31:26 +00:00
|
|
|
/*
|
|
|
|
|
In order to allow placing the text cursor to the start or end of the text by
|
|
|
|
|
clicking in the margin area, we expand the outer boundary of the surface
|
|
|
|
|
outside the parent container using negative margin. Then we shrink the visible
|
|
|
|
|
rendering by applying inner padding. The end result is that the content is
|
|
|
|
|
the same width as in read mode, except with the padding around it now being
|
|
|
|
|
part of it instead of its parent, thus making it treat the area as part
|
|
|
|
|
of content editable.
|
|
|
|
|
*/
|
2014-06-28 16:47:46 +00:00
|
|
|
margin: 0.8em -1em 0 -1em;
|
2014-02-20 22:55:49 +00:00
|
|
|
}
|
2012-08-17 20:16:25 +00:00
|
|
|
|
2014-02-20 22:55:49 +00:00
|
|
|
.ve-init-mw-viewPageTarget-surface .ve-ce-documentNode {
|
2014-06-28 16:47:46 +00:00
|
|
|
padding: 0 1.143em; /* surface-margin-left (1em) / (mw-body-content font-size) 0.875em */
|
2014-02-20 22:55:49 +00:00
|
|
|
}
|
2012-08-17 20:16:25 +00:00
|
|
|
|
2014-11-20 01:02:44 +00:00
|
|
|
.ve-init-mw-viewPageTarget-surface .oo-ui-menuSelectWidget {
|
2014-02-20 22:55:49 +00:00
|
|
|
font-size: 0.8em;
|
Transplant CSS from the main document to each iframe
We previously manually loaded CSS into these frames, which is flawed
because it completely bypasses ResourceLoader (so CSSJanus didn't flip
them, necessitating a bunch of hacks for RTL), and doesn't pull in
MediaWiki styles (so templates inside references don't render correctly).
Instead, this commit copies all styles from the main document into each
frame's document, inlining what it can.
Loading all styles in dialogs and inspectors caused some problems,
initially. We didn't namespace our styles for dialogs vs. inspectors
at all; the only reason inspector styles weren't being applied to dialogs
and vice versa was because we controlled which files were being loaded
in which context. This commit namespaces the inspector and dialog styles
where needed so they don't conflict and try to override each other.
Tested in Vector and Monobook, but not in Apex and not in RTL.
ve.init.mw.ViewPageTarget*.css:
* Namespace styles that are only intended for the main document
* Undo Monobook's font-size: x-small; in frames
*Dialog.js:
* Remove addLocalStylesheet() calls, we don't need those any more
** ve.ui.MWDialog seems to be unneeded now, we may want to remove it
*.css:
* Remove @noflip-ped RTL rules where they were just flipped versions of
their LTR counterparts
ve.ui.Dialog.css, ve.ui.Inspector.css:
* Namespace styles with .ve-ui-dialog-content / .ve-ui-inspector-content
ve.ui.Frame.css:
* Move the margin:0 and padding:0 here (were in the frame <body>'s style
attribute) and add background:none to prevent frames from getting
the skin's background (grey in Vector, a book in Monobook)
ve.ui.Dialog.js, ve.ui.Inspector.js:
* Add ve-ui-dialog-content / ve-ui-inspector-content class to the
frame's content <div> so we can restrict styles to only apply in
dialogs / inspectors
ve.ui.Frame.js:
* Replace infrastructure for @import-ing stylesheets with transplantation
* Remove code polling to see when the stylesheets were loaded
** We can't do this in the new approach AFAIK, since all styles in the
frame are either inlined or inaccessible due to the same-origin policy
** We also shouldn't need it because the browser should have cached the
styles when it loaded the main document
* Apply ve-ui-frame-body class to the frame's <body> so we can style it
** Move inline padding:0;margin:0; into ve.ui.Frame.css
** Move the ve-ltr/ve-rtl class up to the <body>
ve.ui.Window.js:
* Remove infrastructure registering stylesheet URLs to load
Change-Id: I4a37115301811ad860f4578344a04873ea8c2b69
2013-07-03 21:47:52 +00:00
|
|
|
}
|
|
|
|
|
|
2014-11-22 17:42:22 +00:00
|
|
|
.ve-ui-mwSurfaceWidget .ve-ce-surface {
|
|
|
|
|
/* 0.875 (mw-body-content) / 0.8em (window) */
|
|
|
|
|
font-size: 1.09375em;
|
|
|
|
|
}
|
|
|
|
|
|
2013-05-14 23:45:42 +00:00
|
|
|
.ve-init-mw-viewPageTarget-toolbar {
|
2014-02-11 21:58:21 +00:00
|
|
|
margin: -1em -1em 1em -1em;
|
2012-08-20 22:43:47 +00:00
|
|
|
-webkit-transition: margin 200ms ease-out;
|
|
|
|
|
-moz-transition: margin 200ms ease-out;
|
|
|
|
|
-o-transition: margin 200ms ease-out;
|
|
|
|
|
transition: margin 200ms ease-out;
|
2012-08-17 20:16:25 +00:00
|
|
|
position: relative;
|
|
|
|
|
}
|
|
|
|
|
|
2014-06-06 10:04:24 +00:00
|
|
|
.ve-ui-debugBar {
|
2014-04-01 20:17:58 +00:00
|
|
|
padding: 1em;
|
|
|
|
|
margin: 1em -1em -1em -1em;
|
|
|
|
|
border-top: solid 1px #ccc;
|
|
|
|
|
box-shadow: 0 10px 10px -10px rgba(0, 0, 0, 0.15) inset;
|
|
|
|
|
}
|
|
|
|
|
|
2014-06-06 10:04:24 +00:00
|
|
|
.ve-ui-debugBar ol {
|
2014-04-01 20:17:58 +00:00
|
|
|
margin-left: 0;
|
|
|
|
|
}
|
|
|
|
|
|
2014-07-29 11:27:22 +00:00
|
|
|
.ve-ui-overlay-global {
|
2013-06-27 17:25:28 +00:00
|
|
|
z-index: 101; /* #p-personal is z-index 100 in vector :( */
|
|
|
|
|
}
|
2014-06-25 10:36:31 +00:00
|
|
|
|
2014-07-14 21:32:49 +00:00
|
|
|
.oo-ui-actionWidget a:hover {
|
|
|
|
|
text-decoration: none;
|
|
|
|
|
}
|
|
|
|
|
|
2014-06-28 19:27:31 +00:00
|
|
|
/* ve.ce.TableCellnode.css's margin replaced by more specific rule in Vector (div#content p) */
|
2014-06-25 10:36:31 +00:00
|
|
|
/*csslint ids:false */
|
|
|
|
|
#content .ve-ce-tableCellNode .ve-ce-paragraphNode {
|
|
|
|
|
margin: 0;
|
2014-06-28 19:27:31 +00:00
|
|
|
}
|
|
|
|
|
/*csslint ids:true */
|
|
|
|
|
|
|
|
|
|
/* High-definition-specific styles (because Vector adds 1em to the leftNav if width is 982px+ */
|
|
|
|
|
@media screen and (min-width: 982px) {
|
|
|
|
|
.ve-init-mw-viewPageTarget-surface {
|
|
|
|
|
margin: 0.8em -1.5em 0 -1.5em;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.ve-init-mw-viewPageTarget-surface .ve-ce-documentNode {
|
|
|
|
|
padding: 0 1.714em; /* surface-margin-left (1.5em) / (mw-body-content font-size) 0.875em */
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.ve-init-mw-viewPageTarget-toolbar {
|
|
|
|
|
margin: -1.25em -1.5em 1.5em -1.5em;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.ve-ui-debugBar {
|
|
|
|
|
padding: 1.5em;
|
|
|
|
|
margin: 1em -1.5em -1.5em -1.5em;
|
|
|
|
|
}
|
|
|
|
|
}
|