Update natspec comments on state variables.

- changing some warnings to errors
ethereum · Apr 22, 2020 · a1d681d · a1d681d
1 parent 136f24a
commit a1d681d
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 27 deletions.
diff --git a/libsolidity/analysis/DocStringAnalyser.cpp b/libsolidity/analysis/DocStringAnalyser.cpp
@@ -61,18 +61,12 @@ bool DocStringAnalyser::visit(VariableDeclaration const& _variable)
 {
  if (_variable.isStateVariable())
  {
- static set<string> const validPublicTags = set<string>{"dev", "notice", "title", "author"};
+ static set<string> const validPublicTags = set<string>{"notice", "dev"};
+ static set<string> const validNonPublicTags = set<string>{"dev"};
  if (_variable.isPublic())
  parseDocStrings(_variable, _variable.annotation(), validPublicTags, "public state variables");
  else
- {
- parseDocStrings(_variable, _variable.annotation(), validPublicTags, "non-public state variables");
- if (_variable.annotation().docTags.find("notice") != _variable.annotation().docTags.end())
- m_errorReporter.warning(_variable.documentation()->location(), "Documentation tag on non-public state variables will be disallowed in 0.7.0. You will need to use the @dev tag explicitly.");
- }
- if (_variable.annotation().docTags.find("title") != _variable.annotation().docTags.end() ||
- _variable.annotation().docTags.find("author") != _variable.annotation().docTags.end())
- m_errorReporter.warning(_variable.documentation()->location(), "Documentation tag @title and @author is only allowed on contract definitions. It will be disallowed in 0.7.0.");
+ parseDocStrings(_variable, _variable.annotation(), validNonPublicTags, "non-public state variables");
  }
  return false;
 }

diff --git a/libsolidity/parsing/Parser.cpp b/libsolidity/parsing/Parser.cpp
@@ -689,7 +689,7 @@ ASTPointer<VariableDeclaration> Parser::parseVariableDeclaration(
  }
 
  if (!_options.isStateVariable && documentation != nullptr)
- parserWarning("Only state variables can retrieve a docstring. This will be disallowed in 0.7.0.");
+ parserError("Only state variables can retrieve a docstring.");
 
  if (dynamic_cast<FunctionTypeName*>(type.get()) && _options.isStateVariable && m_scanner->currentToken() == Token::LBrace)
  fatalParserError(

diff --git a/test/compilationTests/corion/premium.sol b/test/compilationTests/corion/premium.sol
@@ -11,6 +11,12 @@ contract thirdPartyPContractAbstract {
 
 contract ptokenDB is tokenDB {}
 
+/**
+ *
+ * @title Corion Platform Premium Token
+ * @author iFA @ Corion Platform
+ *
+ */
 contract premium is module, safeMath {
  function replaceModule(address payable addr) external override returns (bool success) {
  require( super.isModuleHandler(msg.sender) );
@@ -23,12 +29,6 @@ contract premium is module, safeMath {
  require( _success && _active );
  _;
  }
- /**
- *
- * @title Corion Platform Premium Token
- * @author iFA @ Corion Platform
- *
- */
 
  string public name = "Corion Premium";
  string public symbol = "CORP";

diff --git a/test/compilationTests/corion/token.sol b/test/compilationTests/corion/token.sol
@@ -11,6 +11,12 @@ contract thirdPartyContractAbstract {
  function approvedCorionToken(address, uint256, bytes calldata) external returns (bool) {}
 }
 
+/**
+ *
+ * @title Corion Platform Token
+ * @author iFA @ Corion Platform
+ *
+ */
 contract token is safeMath, module, announcementTypes {
  /*
  module callbacks
@@ -26,12 +32,7 @@ contract token is safeMath, module, announcementTypes {
  require( _success && _active );
  _;
  }
- /**
- *
- * @title Corion Platform Token
- * @author iFA @ Corion Platform
- *
- */
+
  string public name = "Corion";
  string public symbol = "COR";
  uint8 public decimals = 6;

diff --git a/test/externalTests/colony.sh b/test/externalTests/colony.sh
@@ -34,7 +34,7 @@ function colony_test
  FORCE_ABIv2=false
  CONFIG="truffle.js"
 
- truffle_setup https:/erak/colonyNetwork.git develop_060
+ truffle_setup https:/aarlt/colonyNetwork.git natspec_on_state_variables
  run_install install_fn
 
  cd lib

diff --git a/test/externalTests/zeppelin.sh b/test/externalTests/zeppelin.sh
@@ -33,7 +33,7 @@ function zeppelin_test
  OPTIMIZER_LEVEL=1
  CONFIG="truffle-config.js"
 
- truffle_setup https:/erak/openzeppelin-contracts.git master_060
+ truffle_setup https:/aarlt/openzeppelin-contracts.git master
  run_install install_fn
 
  truffle_run_test compile_fn test_fn

diff --git a/test/libsolidity/syntaxTests/natspec/docstring_author_title_state_variable.sol b/test/libsolidity/syntaxTests/natspec/docstring_author_title_state_variable.sol
@@ -4,4 +4,5 @@ contract C {
  uint private state;
 }
 // ----
-// Warning: (17-56): Documentation tag @title and @author is only allowed on contract definitions. It will be disallowed in 0.7.0.
+// DocstringParsingError: (17-56): Documentation tag @author not valid for non-public state variables.
+// DocstringParsingError: (17-56): Documentation tag @title not valid for non-public state variables.
diff --git a/test/libsolidity/syntaxTests/natspec/docstring_private_state_variable.sol b/test/libsolidity/syntaxTests/natspec/docstring_private_state_variable.sol
@@ -4,4 +4,4 @@ contract C {
  uint private state;
 }
 // ----
-// Warning: (17-74): Documentation tag on non-public state variables will be disallowed in 0.7.0. You will need to use the @dev tag explicitly.
+// DocstringParsingError: (17-74): Documentation tag @notice not valid for non-public state variables.
diff --git a/test/libsolidity/syntaxTests/natspec/docstring_state_variable.sol b/test/libsolidity/syntaxTests/natspec/docstring_state_variable.sol
@@ -3,3 +3,4 @@ contract C {
  /// @dev example of dev
  uint public state;
 }
+// ----
diff --git a/test/libsolidity/syntaxTests/natspec/docstring_variable.sol b/test/libsolidity/syntaxTests/natspec/docstring_variable.sol
@@ -11,4 +11,4 @@ contract C {
  }
 }
 // ----
-// Warning: (290-295): Only state variables can retrieve a docstring. This will be disallowed in 0.7.0.
+// ParserError: (290-295): Only state variables can retrieve a docstring.