NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Ensure constant getters show in docs (#4649)

Browse Source
This commit is contained in:
Francisco
2023-10-04 12:54:49 -03:00
committed by GitHub
parent 2c6b859dd0
commit 39400b78ba
5 changed files with 23 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/templates/properties.js vendored
View File

@ -1,4 +1,4 @@
const { isNodeType } = require('solidity-ast/utils');
const { isNodeType, findAll } = require('solidity-ast/utils');
const { slug } = require('./helpers');
module.exports.anchor = function anchor({ item, contract }) {
@ -39,6 +39,21 @@ module.exports['has-errors'] = function ({ item }) {
return item.inheritance.some(c => c.errors.length > 0);
};
module.exports.functions = function ({ item }) {
return [
...[...findAll('FunctionDefinition', item)].filter(f => f.visibility !== 'private'),
...[...findAll('VariableDeclaration', item)].filter(f => f.visibility === 'public'),
];
};
module.exports.returns2 = function ({ item }) {
if (isNodeType('VariableDeclaration', item)) {
return [{ type: item.typeDescriptions.typeString }];
} else {
return item.returns;
}
};
module.exports['inherited-functions'] = function ({ item }) {
const { inheritance } = item;
const baseFunctions = new Set(inheritance.flatMap(c => c.functions.flatMap(f => f.baseFunctions ?? [])));