Forbid 'title' and 'author' for state var natspecs.

ethereum · Mar 24, 2020 · 9e6d5c4 · 9e6d5c4
1 parent c8700fe
commit 9e6d5c4
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 8 deletions.
diff --git a/libsolidity/analysis/DocStringAnalyser.cpp b/libsolidity/analysis/DocStringAnalyser.cpp
@@ -130,7 +130,7 @@ void DocStringAnalyser::handleDeclaration(
 	StructurallyDocumentedAnnotation& _annotation
 )
 {
-	static set<string> const validPublicTags = set<string>{"author", "title", "dev", "notice"};
+	static set<string> const validPublicTags = set<string>{"dev", "notice"};
 	parseDocStrings(_node, _annotation, validPublicTags, "state variables");
 }
 

diff --git a/test/libsolidity/SolidityNatspecJSON.cpp b/test/libsolidity/SolidityNatspecJSON.cpp
@@ -208,7 +208,6 @@ BOOST_AUTO_TEST_CASE(dev_public_state_variable)
 {
 	char const* sourceCode = R"(
 		contract test {
-			/// @author example of author
 			/// @notice example of notice
 			/// @dev example of dev
 			uint public state;
@@ -218,7 +217,6 @@ BOOST_AUTO_TEST_CASE(dev_public_state_variable)
 	char const* natspec = "{"
 						  "\"methods\":{"
 						  "    \"state()\":{ \n"
-						  "        \"author\": \"example of author\",\n"
 						  "        \"details\": \"example of dev\"\n"
 						  "    }\n"
 						  "}}";
@@ -231,7 +229,6 @@ BOOST_AUTO_TEST_CASE(user_variable_declaration)
 	char const* sourceCode = R"(
 		contract test {
 			function f() public pure returns (uint) {
-				/// @author example of author
 				/// @notice example of notice
 				/// @dev example of dev
 				uint state = 42;
@@ -251,7 +248,6 @@ BOOST_AUTO_TEST_CASE(user_public_state_variable)
 {
 	char const* sourceCode = R"(
 		contract test {
-			/// @author example of author
 			/// @notice example of notice
 			/// @dev example of dev
 			uint public state;
@@ -272,7 +268,6 @@ BOOST_AUTO_TEST_CASE(dev_private_state_variable)
 {
 	char const* sourceCode = R"(
 		contract test {
-			/// @author example of author
 			/// @notice example of notice
 			/// @dev example of dev
 			uint private state;
@@ -283,7 +278,6 @@ BOOST_AUTO_TEST_CASE(dev_private_state_variable)
 			"\"methods\":{},\n"
 			"\"stateVariables\":{\n"
 				"\"state\":{\n"
-					"\"author\": \"example of author\",\n"
 					"\"details\": \"example of dev\"\n"
 				"}\n"
 			"}\n"
@@ -296,7 +290,6 @@ BOOST_AUTO_TEST_CASE(user_private_state_variable)
 {
 	char const* sourceCode = R"(
 		contract test {
-			/// @author example of author
 			/// @notice example of notice
 			/// @dev example of dev
 			uint private state;