From 6258e9886e022ff2e0122dbca95b43870dc1ace3 Mon Sep 17 00:00:00 2001
From: Hackerpilot <briancschott@gmail.com>
Date: Wed, 3 Sep 2014 08:42:47 +0000
Subject: [PATCH] Reduce noise in undocumented symbol check

---
 src/analysis/undocumented.d | 32 ++++++++++++++++++++++++++------
 1 file changed, 26 insertions(+), 6 deletions(-)

diff --git a/src/analysis/undocumented.d b/src/analysis/undocumented.d
index cb2d8f5..ad40349 100644
--- a/src/analysis/undocumented.d
+++ b/src/analysis/undocumented.d
@@ -12,7 +12,8 @@ import analysis.base;
 import std.stdio;
 
 /**
- * Checks for undocumented public declarations
+ * Checks for undocumented public declarations. Ignores some operator overloads,
+ * main functions, and functions whose name starts with "get" or "set".
  */
 class UndocumentedDeclarationCheck : BaseAnalyzer
 {
@@ -112,8 +113,17 @@ private:
 				{
 					static if (hasMember!(T, "name"))
 					{
-						import std.algorithm : canFind;
-						if (!ignoredNames.canFind(declaration.name.text))
+						static if (is (T == FunctionDeclaration))
+						{
+							import std.algorithm : canFind;
+							if (!(ignoredFunctionNames.canFind(declaration.name.text)
+								|| isGetterOrSetter(declaration.name.text)))
+							{
+								addMessage(declaration.name.line, declaration.name.column,
+									declaration.name.text);
+							}
+						}
+						else
 						{
 							addMessage(declaration.name.line, declaration.name.column,
 								declaration.name.text);
@@ -124,12 +134,21 @@ private:
 						addMessage(declaration.line, declaration.column, null);
 					}
 				}
-				static if (!is (T == TemplateDeclaration))
+				static if (!(is (T == TemplateDeclaration)
+					|| is(T == FunctionDeclaration)))
+				{
 					declaration.accept(this);
+				}
 			}
 		}
 	}
 
+	static bool isGetterOrSetter(string name)
+	{
+		import std.algorithm:startsWith;
+		return name.startsWith("get") || name.startsWith("set");
+	}
+
 	void addMessage(size_t line, size_t column, string name)
 	{
 		import std.string : format;
@@ -182,9 +201,10 @@ private:
 }
 
 // Ignore undocumented symbols with these names
-private immutable string[] ignoredNames = [
+private immutable string[] ignoredFunctionNames = [
 	"opCmp",
 	"opEquals",
 	"toString",
-	"toHash"
+	"toHash",
+	"main"
 ];