Add NatSpec for Community Driven Governance, Deploy Governance Rules and Deploy Proposals Manager

Author: mr-ubik

contracts/CommunityDrivenGovernance.sol

@@ -1,47 +1,74 @@
-/* Description:
- * DFO Protocol - Community-Driven Governance.
- * This is the well-known Functionality provided by the DFO protocol, which is triggered when a Proposal is finalized (whether it is successful or not).
- * In case the Proposal Survey is successful (result value set to true), its proposer will receive an amount of Voting Tokens as a reward.
- * The reward amount is initially decided during the DFO Creation and can be changed with a proposal changing the value of the surveySingleReward variable set into the DFO StateHolder.
- */
-/* Discussion:
- * https://gitcoin.co/grants/154/decentralized-flexible-organization
- */
+// SPDX-License-Identifier: BSD-2
+
 pragma solidity ^0.6.0;
 
+/*
+ * @title DFO Protocol - Community-Driven Governance.
+ * @dev This is the well-known Functionality provided by the DFO protocol, which is triggered when a Proposal
+ * is finalized (whether it is successful or not).
+ * In case the Proposal Survey is successful (result value set to true), its proposer will receive
+ * an amount of Voting Tokens as a reward.
+ * The reward amount is initially decided during the DFO Creation and can be changed with a proposal
+ * changing the value of the surveySingleReward variable set into the DFO StateHolder.
+ */
 contract CommunityDrivenGovernance {
-
     string private _metadataLink;
 
+    /**
+     * @dev Contract constructor
+     * @param metadataLink Link to the metadata of the Proposal
+     */
     constructor(string memory metadataLink) public {
         _metadataLink = metadataLink;
     }
 
-    function getMetadataLink() public view returns(string memory) {
+    /**
+     * @dev GETTER for the metadataLink
+     * @return metadataLink Link to the metadata of the Proposal
+     */
+    function getMetadataLink()
+        public
+        view
+        returns (string memory metadataLink)
+    {
         return _metadataLink;
     }
 
-    function onStart(address, address) public {
-    }
+    function onStart(address, address) public {}
 
-    function onStop(address) public {
-    }
+    function onStop(address) public {}
 
+    /**
+     * @dev Trigger for the finalization of a proposal.
+     * @param proposal Address for the proposal
+     * @param result
+     */
     function proposalEnd(address proposal, bool result) public {
-        if(!result) {
+        if (!result) {
             return;
         }
         IMVDProxy proxy = IMVDProxy(msg.sender);
-        if(IMVDFunctionalitiesManager(proxy.getMVDFunctionalitiesManagerAddress()).hasFunctionality("getSurveySingleReward")) {
-            uint256 surveySingleReward = toUint256(proxy.read("getSurveySingleReward", bytes("")));
-            if(surveySingleReward > 0) {
-                proxy.transfer(IMVDFunctionalityProposal(proposal).getProposer(), surveySingleReward, proxy.getToken());
+        if (
+            IMVDFunctionalitiesManager(
+                proxy.getMVDFunctionalitiesManagerAddress()
+            )
+                .hasFunctionality("getSurveySingleReward")
+        ) {
+            uint256 surveySingleReward = toUint256(
+                proxy.read("getSurveySingleReward", bytes(""))
+            );
+            if (surveySingleReward > 0) {
+                proxy.transfer(
+                    IMVDFunctionalityProposal(proposal).getProposer(),
+                    surveySingleReward,
+                    proxy.getToken()
+                );
             }
         }
     }
 
-    function toUint256(bytes memory bs) private pure returns(uint256 x) {
-        if(bs.length >= 32) {
+    function toUint256(bytes memory bs) private pure returns (uint256 x) {
+        if (bs.length >= 32) {
             assembly {
                 x := mload(add(bs, add(0x20, 0)))
             }
@@ -50,21 +77,45 @@ contract CommunityDrivenGovernance {
 }
 
 interface IVotingToken {
-    function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
+    function transferFrom(
+        address sender,
+        address recipient,
+        uint256 amount
+    ) external returns (bool);
 }
 
 interface IMVDProxy {
-    function getToken() external view returns(address);
-    function getMVDFunctionalitiesManagerAddress() external view returns(address);
-    function transfer(address receiver, uint256 value, address token) external;
-    function hasFunctionality(string calldata codeName) external view returns(bool);
-    function read(string calldata codeName, bytes calldata data) external view returns(bytes memory returnData);
+    function getToken() external view returns (address);
+
+    function getMVDFunctionalitiesManagerAddress()
+        external
+        view
+        returns (address);
+
+    function transfer(
+        address receiver,
+        uint256 value,
+        address token
+    ) external;
+
+    function hasFunctionality(string calldata codeName)
+        external
+        view
+        returns (bool);
+
+    function read(string calldata codeName, bytes calldata data)
+        external
+        view
+        returns (bytes memory returnData);
 }
 
 interface IMVDFunctionalityProposal {
-    function getProposer() external view returns(address);
+    function getProposer() external view returns (address);
 }
 
 interface IMVDFunctionalitiesManager {
-    function hasFunctionality(string calldata codeName) external view returns(bool);
-}
+    function hasFunctionality(string calldata codeName)
+        external
+        view
+        returns (bool);
+}