new

contracts/README.adoc

@@ -0,0 +1,65 @@
+= OSX Commons
+
+This is the reference guide for the link:https://github.com/aragon/osx-commons[osx-commons-contracts] package.
+
+== Core
+
+{{IDAO}}
+
+{{Executor}}
+
+{{PermissionLib}}
+
+{{DAOAuthorizable}}
+
+{{DAOAuthorizableUpgradeable}}
+
+== Plugins
+
+{{Plugin}}
+
+{{PluginCloneable}}
+
+{{PluginUUPSUpgradeable}}
+
+{{PluginSetup}}
+
+{{PluginSetupUpgradeable}}
+
+== Plugins Extensions
+
+{{Proposal}}
+
+{{ProposalUpgradeable}}
+
+{{IMembership}}
+
+{{Addresslist}}
+
+== Utils
+
+{{MetadataExtension}}
+
+{{MetadataExtensionUpgradeable}}
+
+{{ProtocolVersion}}
+
+{{BitMap}}
+
+{{Ratio}}
+
+{{ProxyFactory}}
+
+{{ProxyLib}}
+
+== Conditions
+
+{{PermissionCondition}}
+
+{{PermissionConditionUpgradeable}}
+
+{{RuledCondition}}
+
+{{PermissionManager}}
+
+{{CallbackHandler}}

contracts/docs/antora.yml

@@ -0,0 +1,7 @@
+name: osx-commons-contracts
+title: OSX Commons
+version: 1.x
+prerelease: false
+nav:
+  - modules/ROOT/nav.adoc
+  - modules/api/nav.adoc

contracts/docs/config.js

@@ -0,0 +1,14 @@
+const path = require('path');
+const fs = require('fs');
+
+/** @type import('solidity-docgen/dist/config').UserConfig */
+module.exports = {
+  outputDir: 'docs/modules/api/pages',
+  templates: 'docs/templates',
+  exclude: ['mocks', 'test'],
+  pageExtension: '.adoc',
+  collapseNewlines: true,
+  pages: (_, file, config) => {
+    return 'osx-commons' + config.pageExtension;
+  },
+};

contracts/docs/modules/ROOT/nav.adoc

@@ -0,0 +1 @@
+* xref:index.adoc[Overview]

contracts/docs/modules/ROOT/pages/index.adoc

@@ -0,0 +1,3 @@
+= OSX Commons.
+
+link:https://github.com/aragon/osx-commons[OSX commons] package is used to help with Aragon's project to avoid code duplication. 

contracts/docs/modules/api/nav.adoc

@@ -0,0 +1,2 @@
+.API
+* xref:osx-commons.adoc[Osx Commons]

contracts/docs/templates/contract.hbs

@@ -1,12 +1,175 @@
-## Description
+{{#each items}}
+:{{name}}: pass:normal[xref:#{{anchor}}[`++{{name}}++`]]
+{{/each}}
+
+[.contract]
+[[{{anchor}}]]
+=== `++{{name}}++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v{{oz-version}}/{{__item_context.file.absolutePath}}[{github-icon},role=heading-link]
 
-{{{natspec.notice}}}
 
 {{{natspec.dev}}}
 
-## Implementation
+{{!-- {{#if modifiers}}
+[.contract-index]
+.Modifiers
+--
+{{#if (isLocalContract contract.name)}}
+{{#each modifiers}}
+* {xref-{{anchor~}} }[`++{{name}}({{names params}})++`]
+{{/each}}
+{{else if (isAragonInherittedContract contract) }}
+{{#each modifiers}}
+* link:{{getExternalLink __item_context.file.absolutePath}}[{{name}}]
+{{/each}}
+{{/if}}
+--
+{{/if}} --}}
+
+{{#if has-functions}}
+[.contract-index]
+.Functions
+--
+{{#each inherited-functions}}
+{{#unless @first}}
+[.contract-subindex-inherited]
+.{{contract.name}}
+{{/unless}}
+{{#if (isLocalContract contract.name)}}
+{{#each functions}}
+* {xref-{{anchor~}} }[`++{{name}}({{names params}})++`]
+{{/each}}
+{{else if (isAragonInherittedContract contract.__item_context.file.absolutePath) }}
+{{#each functions}}
+* link:{{getExternalLink __item_context.file.absolutePath}}[{{name}}]
+{{/each}}
+{{/if}}
+
+{{/each}}
+--
+{{/if}}
+
+
+{{#if has-events}}
+[.contract-index]
+.Events
+--
+{{#each inheritance}}
+{{#unless @first}}
+[.contract-subindex-inherited]
+.{{name}}
+{{/unless}}
+{{#if (isLocalContract name)}}
+{{#each events}}
+* {xref-{{anchor~}} }[`++{{name}}({{names params}})++`]
+{{/each}}
+{{else if (isAragonInherittedContract __item_context.file.absolutePath) }}
+{{#each events}}
+* link:{{getExternalLink __item_context.file.absolutePath}}[{{name}}]
+{{/each}}
+{{/if}}
+
+{{/each}}
+--
+{{/if}}
+
+{{#if has-errors}}
+[.contract-index]
+.Errors
+--
+{{#each inheritance}}
+{{#unless @first}}
+[.contract-subindex-inherited]
+.{{name}}
+{{/unless}}
+{{#if (isLocalContract contract.name)}}
+{{#each errors}}
+* {xref-{{anchor~}} }[`++{{name}}({{names params}})++`]
+{{/each}}
+{{else if (isAragonInherittedContract __item_context.file.absolutePath) }}
+{{#each errors}}
+* link:{{getExternalLink __item_context.file.absolutePath}}[{{name}}]
+{{/each}}
+{{/if}}
+
+{{/each}}
+--
+{{/if}}
+
+
+{{#if has-internal-variables}}
+[.contract-index]
+.Internal Variables
+--
+{{#each inheritance}}
+{{#unless @first}}
+[.contract-subindex-inherited]
+.{{name}}
+{{/unless}}
+{{#if (isLocalContract contract.name)}}
+{{#each internal-variables}}
+* {xref-{{anchor~}} }[`++{{typeDescriptions.typeString}} {{#if constant}}constant{{/if}} {{name}}++`]
+{{/each}}
+{{else if (isAragonInherittedContract __item_context.file.absolutePath) }}
+{{#each errors}}
+* link:{{getExternalLink __item_context.file.absolutePath}}[{{name}}]
+{{/each}}
+{{/if}}
+
+{{/each}}
+--
+{{/if}}
+
+{{#each modifiers}}
+[.contract-item]
+[[{{anchor}}]]
+==== `[.contract-item-name]#++{{name}}++#++({{typed-params params}})++` [.item-kind]#modifier#
+
+{{natspec.notice}}
+
+{{natspec.dev}}
+
+{{/each}}
+
+{{#each functions}}
+[.contract-item]
+[[{{anchor}}]]
+==== `[.contract-item-name]#++{{name}}++#++({{typed-params params}}){{#if returns2}} → {{typed-params returns2}}{{/if}}++` [.item-kind]#{{visibility}}#
+
+{{natspec.notice}}
+
+{{natspec.dev}}
+
+{{/each}}
+
+{{#each events}}
+[.contract-item]
+[[{{anchor}}]]
+==== `[.contract-item-name]#++{{name}}++#++({{typed-params params}})++` [.item-kind]#event#
+
+{{natspec.notice}}
+
+{{natspec.dev}}
+
+{{/each}}
+
+{{#each errors}}
+[.contract-item]
+[[{{anchor}}]]
+==== `[.contract-item-name]#++{{name}}++#++({{typed-params params}})++` [.item-kind]#error#
+
+{{natspec.notice}}
+
+{{natspec.dev}}
+
+{{/each}}
+
+{{#each internal-variables}}
+[.contract-item]
+[[{{anchor}}]]
+==== `{{typeDescriptions.typeString}} [.contract-item-name]#++{{name}}++#` [.item-kind]#internal{{#if constant}} constant{{/if}}#
+
+{{natspec.notice}}
+
+{{natspec.dev}}
 
-{{#each items}}
-{{>item}}
 {{/each}}
-<!--CONTRACT_END-->