- {this.removeCommentsFromDocblock(content.docblock)}
+ {removeCommentsFromDocblock(content.docblock)}
{this.renderMethods(content.methods)}
{this.renderProperties(content.properties)}
@@ -404,6 +412,62 @@ var APIDoc = React.createClass({
}
});
+var Method = React.createClass({
+ renderTypehintRec: function(typehint) {
+ if (typehint.type === 'simple') {
+ return typehint.value;
+ }
+
+ if (typehint.type === 'generic') {
+ return this.renderTypehintRec(typehint.value[0]) + '<' + this.renderTypehintRec(typehint.value[1]) + '>';
+ }
+
+ return JSON.stringify(typehint);
+
+ },
+
+ renderTypehint: function(typehint) {
+ if (typeof typehint === 'object' && typehint.name) {
+ return renderType(typehint);
+ }
+ try {
+ var typehint = JSON.parse(typehint);
+ } catch (e) {
+ return typehint;
+ }
+
+ return this.renderTypehintRec(typehint);
+ },
+
+ render: function() {
+ return (
+
+
+ {this.props.modifiers.length &&
+ {this.props.modifiers.join(' ') + ' '}
+ || ''}
+ {this.props.name}
+
+ ({this.props.params
+ .map((param) => {
+ var res = param.name;
+ if (param.type) {
+ res += ': ' + this.renderTypehint(param.type);
+ }
+ return res;
+ })
+ .join(', ')})
+ {this.props.returns && ': ' + this.renderTypehint(this.props.returns.type)}
+
+
+ {this.props.description &&
+ {this.props.description}
+ }
+
+ );
+ },
+});
+
var EmbeddedSimulator = React.createClass({
render: function() {
if (!this.props.shouldRender) {
diff --git a/website/package.json b/website/package.json
index 31600f115dcc0e..270037f3cadfdf 100644
--- a/website/package.json
+++ b/website/package.json
@@ -13,7 +13,7 @@
"mkdirp": "^0.5.1",
"optimist": "0.6.0",
"react": "~0.13.0",
- "react-docgen": "^2.0.1",
+ "react-docgen": "^2.8.0",
"react-page-middleware": "git://github.com/facebook/react-page-middleware.git",
"request": "^2.69.0",
"semver-compare": "^1.0.0"
diff --git a/website/server/extractDocs.js b/website/server/extractDocs.js
index 6b8c14ad5968ea..602eaf2c276380 100644
--- a/website/server/extractDocs.js
+++ b/website/server/extractDocs.js
@@ -68,12 +68,36 @@ function getExample(componentName, componentPlatform) {
};
}
+// Add methods that should not appear in the components documentation.
+var methodsBlacklist = [
+ // Native methods mixin.
+ 'getInnerViewNode',
+ 'setNativeProps',
+ // Touchable mixin.
+ 'touchableHandlePress' ,
+ 'touchableHandleActivePressIn',
+ 'touchableHandleActivePressOut',
+ 'touchableHandleLongPress',
+ 'touchableGetPressRectOffset',
+ 'touchableGetHitSlop',
+ 'touchableGetHighlightDelayMS',
+ 'touchableGetLongPressDelayMS',
+ 'touchableGetPressOutDelayMS',
+ // Scrollable mixin.
+ 'getScrollableNode',
+ 'getScrollResponder',
+];
+
+function filterMethods(method) {
+ return method.name[0] !== '_' && methodsBlacklist.indexOf(method.name) === -1;
+}
+
// Determines whether a component should have a link to a runnable example
function isRunnable(componentName, componentPlatform) {
var path = '../Examples/UIExplorer/' + componentName + 'Example.js';
if (!fs.existsSync(path)) {
- path = '../Examples/UIExplorer/' + componentName + 'Example.'+ componentPlatform +'.js';
+ path = '../Examples/UIExplorer/' + componentName + 'Example.' + componentPlatform + '.js';
if (!fs.existsSync(path)) {
return false;
}
@@ -92,9 +116,6 @@ function shouldDisplayInSidebar(componentName) {
}
function getNextComponent(i) {
- var next;
- var filepath = all[i];
-
if (all[i + 1]) {
var nextComponentName = getNameFromPath(all[i + 1]);
@@ -125,6 +146,10 @@ function componentsToMarkdown(type, json, filepath, i, styles) {
}
json.example = getExample(componentName, componentPlatform);
+ if (json.methods) {
+ json.methods = json.methods.filter(filterMethods);
+ }
+
// Put Flexbox into the Polyfills category
var category = (type === 'style' ? 'Polyfills' : type + 's');
var next = getNextComponent(i);