fixed administratable docstring and refreshed ./docs

docs/Administratable.md

@@ -36,7 +36,7 @@ Checks that the caller is either a provided adress, admin or role.
 
 _Parameters:_
 
-- `allowedAddress`: An exempt address provided that shall be allowed to proceed.  
+- `allowedAddress`: An exempt address provided that shall be allowed to proceed.
 
 
 
@@ -49,14 +49,13 @@ roles are ADMIN (6), ACCOUNTANT (2), REVIEWER (3), FUND_FACTORY (4) and ORG_FACT
 
 
 ## Methods
-### `isEqual(string s1, string s2) → bool` (internal)
+### `isEqual(string s1, string s2) → bool` - internal
 Returns true if two strings are equal, false otherwise
 
 
 
 _Parameters:_
-- `s1`: First string to compare
-
-- `s2`: Second string to compare
+ - `s1`: First string to compare
+ - `s2`: Second string to compare
 
 

docs/EndaomentAdmin.md

@@ -18,47 +18,46 @@ _Parameters:_
 
 
 ## Methods
-### `setRole(enum IEndaomentAdmin.Role role, address account)` (public)
+### `setRole(enum IEndaomentAdmin.Role role, address account)` - public
 Set a new account on a given role and emit a `RoleModified` event
 if the role holder has changed. Only the owner may call this function.
 
 
 
 _Parameters:_
-- `role`: The role that the account will be set for.
+ - `role`: The role that the account will be set for.
+ - `account`: The account to set as the designated role bearer.
 
-- `account`: The account to set as the designated role bearer.
-
-### `removeRole(enum IEndaomentAdmin.Role role)` (public)
+### `removeRole(enum IEndaomentAdmin.Role role)` - public
 Remove any current role bearer for a given role and emit a
 `RoleModified` event if a role holder was previously set. Only the owner
 may call this function.
 
 
 
 _Parameters:_
-- `role`: The role that the account will be removed from.
+ - `role`: The role that the account will be removed from.
 
-### `pause(enum IEndaomentAdmin.Role role)` (public)
+### `pause(enum IEndaomentAdmin.Role role)` - public
 Pause a currently unpaused role and emit a `RolePaused` event. Only
 the owner or the designated pauser may call this function. Also, bear in
 mind that only the owner may unpause a role once paused.
 
 
 
 _Parameters:_
-- `role`: The role to pause.
+ - `role`: The role to pause.
 
-### `unpause(enum IEndaomentAdmin.Role role)` (public)
+### `unpause(enum IEndaomentAdmin.Role role)` - public
 Unpause a currently paused role and emit a `RoleUnpaused` event.
 Only the owner may call this function.
 
 
 
 _Parameters:_
-- `role`: The role to pause.
+ - `role`: The role to pause.
 
-### `isPaused(enum IEndaomentAdmin.Role role) → bool` (external)
+### `isPaused(enum IEndaomentAdmin.Role role) → bool` - external
 External view function to check whether or not the functionality
 associated with a given role is currently paused or not. The owner or the
 pauser may pause any given role (including the pauser itself), but only the
@@ -68,27 +67,27 @@ functions directly.
 
 
 _Parameters:_
-- `role`: The role to check the pause status on.
+ - `role`: The role to check the pause status on.
 
 
-### `isRole(enum IEndaomentAdmin.Role role) → bool` (external)
+### `isRole(enum IEndaomentAdmin.Role role) → bool` - external
 External view function to check whether the caller is the current
 role holder.
 
 
 
 _Parameters:_
-- `role`: The role to check for.
+ - `role`: The role to check for.
 
 
-### `getRoleAddress(enum IEndaomentAdmin.Role role) → address` (external)
+### `getRoleAddress(enum IEndaomentAdmin.Role role) → address` - external
 External view function to check the account currently holding the
 given role.
 
 
 
 _Parameters:_
-- `role`: The desired role to fetch the current address of.
+ - `role`: The desired role to fetch the current address of.
 
 
 

docs/EndaomentAdminStorage.md

@@ -6,13 +6,13 @@ subsequently deployed Org and Fund contracts.
 
 
 ## Methods
-### `updateEndaomentAdmin(address newAdmin)` (public)
+### `updateEndaomentAdmin(address newAdmin)` - public
 Updates address of the endaomentAdmin contract and emits `EndaomentAdminChanged` event.
 
 
 
 _Parameters:_
-- `newAdmin`: New address of the endaomentAdmin contract
+ - `newAdmin`: New address of the endaomentAdmin contract
 
 
 ## Events

docs/Fund.md

@@ -9,89 +9,80 @@ recipient Org contract.
 
 
 ## Methods
-### `constructor(address fundManager, address fundFactory)` (public)
+### `constructor(address fundManager, address fundFactory)` - public
 Create new Fund
 
 
 
 _Parameters:_
-- `fundManager`: Address of the Fund's Primary Advisor
+ - `fundManager`: Address of the Fund's Primary Advisor
+ - `fundFactory`: Address of the Factory contract.
 
-- `fundFactory`: Address of the Factory contract.
-
-### `changeManager(address newManager)` (public)
+### `changeManager(address newManager)` - public
 Changes Fund Primary Advisor and emits a `ManagerChanged` event
 
 
 
 _Parameters:_
-- `newManager`: The address of the new PrimaryAdvisor.
+ - `newManager`: The address of the new PrimaryAdvisor.
 
-### `checkRecipient(address recipient, address orgFactoryContractAddress) → bool` (public)
+### `checkRecipient(address recipient, address orgFactoryContractAddress) → bool` - public
 Checks recipient of a Grant is an address created by the OrgFactory
 
 
 
 _Parameters:_
-- `recipient`: The address of the Grant recipient.
-
-- `orgFactoryContractAddress`: Address of the OrgFactory contract.
+ - `recipient`: The address of the Grant recipient.
+ - `orgFactoryContractAddress`: Address of the OrgFactory contract.
 
 
-### `getSummary(address tokenAddress) → uint256, address` (external)
+### `getSummary(address tokenAddress) → uint256, address` - external
 Returns summary of details about the fund [tokenBalance, number of grants, managerAddress].
 
 
 
 _Parameters:_
-- `tokenAddress`: The token address of the ERC20 being used by the web-server.
+ - `tokenAddress`: The token address of the ERC20 being used by the web-server.
 
 
-### `createGrant(string grantId, string description, uint256 value, address recipient)` (public)
+### `createGrant(string grantId, string description, uint256 value, address recipient)` - public
 Creates new Grant Recommendation and emits a `GrantCreated` event.
 
 
 
 _Parameters:_
-- `grantId`: UUID representing this grant
-
-- `description`: The address of the Owner.
-
-- `value`: The value of the grant in base units.
-
-- `recipient`: The address of the recieving organization's contract.
+ - `grantId`: UUID representing this grant
+ - `description`: The address of the Owner.
+ - `value`: The value of the grant in base units.
+ - `recipient`: The address of the recieving organization's contract.
 
-### `updateGrant(string grantId, string description, uint256 value, address recipient)` (public)
+### `updateGrant(string grantId, string description, uint256 value, address recipient)` - public
 Updates Grant Recommendation and emits a `GrantUpdated` event.
 
 
 
 _Parameters:_
-- `grantId`: UUID representing this grant
+ - `grantId`: UUID representing this grant
+ - `description`: The address of the Owner.
+ - `value`: The value of the grant in base units.
+ - `recipient`: The address of the recieving organization's contract.
 
-- `description`: The address of the Owner.
-
-- `value`: The value of the grant in base units.
-
-- `recipient`: The address of the recieving organization's contract.
-
-### `rejectGrant(string grantId)` (public)
+### `rejectGrant(string grantId)` - public
 Rejects Grant Recommendation and emits a `GrantRejected` event.
 
 
 
 _Parameters:_
-- `grantId`: UUID representing this grant
+ - `grantId`: UUID representing this grant
 
-### `finalizeGrant(string grantId, address tokenAddress)` (public)
+### `finalizeGrant(string grantId, address tokenAddress)` - public
 Approves Grant Recommendation and emits a `GrantFinalized` event.
 
 
 
 _Parameters:_
-- `grantId`: UUID of the grant being finalized
-
-- `tokenAddress`: The ERC20 token address of the token prescribed by the web-server.
+ - `grantId`: UUID of the grant being finalized
+ - `tokenAddress`: The ERC20 token address of the token prescribed by the web-server.
 
 
 ## Events

docs/FundFactory.md

@@ -5,21 +5,21 @@ instantiate new Fund contracts.
 
 
 ## Methods
-### `constructor(address adminContractAddress)` (public)
+### `constructor(address adminContractAddress)` - public
 Create new Fund Factory
 
 
 
 _Parameters:_
-- `adminContractAddress`: Address of EndaomentAdmin contract.
+ - `adminContractAddress`: Address of EndaomentAdmin contract.
 
-### `createFund(address managerAddress)` (public)
+### `createFund(address managerAddress)` - public
 Creates new Fund and emits a `FundCreated` event.
 
 
 
 _Parameters:_
-- `managerAddress`: The address of the Fund's Primary Advisor
+ - `managerAddress`: The address of the Fund's Primary Advisor
 
 
 ## Events

docs/Org.md

@@ -7,73 +7,69 @@ the organization can directly receive grant awards from Endaoment Funds.
 
 
 ## Methods
-### `constructor(uint256 ein, address orgFactory)` (public)
+### `constructor(uint256 ein, address orgFactory)` - public
 Create new Organization Contract
 
 
 
 _Parameters:_
-- `ein`: The U.S. Tax Identification Number for the Organization
+ - `ein`: The U.S. Tax Identification Number for the Organization
+ - `orgFactory`: Address of the Factory contract.
 
-- `orgFactory`: Address of the Factory contract.
-
-### `claimRequest(string claimId, string fName, string lName, string eMail, address orgAdminWalletAddress)` (public)
+### `claimRequest(string claimId, string fName, string lName, string eMail, address orgAdminWalletAddress)` - public
 Creates Organization Claim and emits a `ClaimCreated` event
 
 
 
 _Parameters:_
-- `claimId`: UUID representing this claim
-
-- `fName`: First name of Administrator
-
-- `lName`: Last name of Administrator
+ - `claimId`: UUID representing this claim
+ - `fName`: First name of Administrator
+ - `lName`: Last name of Administrator
+ - `eMail`: Email contact for Organization Administrator.
+ - `orgAdminWalletAddress`: Wallet address of Organization's Administrator.
 
-- `eMail`: Email contact for Organization Administrator.
-
-- `orgAdminWalletAddress`: Wallet address of Organization's Administrator.
-
-### `approveClaim(string claimId)` (public)
+### `approveClaim(string claimId)` - public
 Approves an Organization Claim and emits a `ClaimApproved` event
 
 
 
 _Parameters:_
-- `claimId`: UUID of the claim being approved
+ - `claimId`: UUID of the claim being approved
 
-### `rejectClaim(string claimId)` (public)
+### `rejectClaim(string claimId)` - public
 Rejects an Organization Claim and emits a 'ClaimRejected` event
 
 
 
 _Parameters:_
-- `claimId`: UUID of the claim being rejected
+ - `claimId`: UUID of the claim being rejected
 
-### `cashOutOrg(address tokenAddress)` (public)
+### `cashOutOrg(address tokenAddress)` - public
 Cashes out Organization Contract and emits a `CashOutComplete` event
 
 
 
 _Parameters:_
-- `tokenAddress`: ERC20 address of desired token withdrawal
+ - `tokenAddress`: ERC20 address of desired token withdrawal
 
-### `getTokenBalance(address tokenAddress) → uint256` (external)
+### `getTokenBalance(address tokenAddress) → uint256` - external
 Retrieves Token Balance of Org Contract
 
 
 
 _Parameters:_
-- `tokenAddress`: Address of desired token to query for balance
+ - `tokenAddress`: Address of desired token to query for balance
 
 
-### `orgWallet() → address` (public)
+### `orgWallet() → address` - public
 Org Wallet convenience accessor
 
 
 
 
 
 
+
 ## Events
 - `CashOutComplete(uint256 cashOutAmount)`
 - `ClaimCreated(string claimId, struct Org.Claim claim)`