Merge remote-tracking branch 'origin/fastpath'

* origin/fastpath:
  Improve Broxygen end-of-sentence detection.

CHANGES

@@ -1,4 +1,8 @@
 
+2.2-beta-57 | 2013-10-11 17:23:25 -0700
+
+  * Improve Broxygen end-of-sentence detection. (Jon Siwek)
+
 2.2-beta-55 | 2013-10-10 13:36:38 -0700
 
   * A couple of new TLS extension numbers. (Bernhard Amann)

VERSION

@@ -1 +1 @@
-2.2-beta-55
+2.2-beta-57

aux/broctl

@@ -1 +1 @@
-Subproject commit 7ca51fc46c5c3dd4f3d803e5c617c2e35129fb05
+Subproject commit 81fa2d664a7ef7306a03928484b10611fbe893b8

doc/scripts/example.bro

@@ -167,6 +167,10 @@ export {
     # it's fine if the type is inferred, that information is self-documenting
     global var_without_explicit_type = "this works";
 
+    ## The first.sentence for the summary text ends here.  And this second
+    ## sentence doesn't show in the short description.
+    global dummy: string;
+
     ############## functions/events ############
 
     ## Summarize purpose of "a_function" here.

src/BroDocObj.cc

@@ -74,6 +74,27 @@ int BroDocObj::LongestShortDescLen() const
 	return max;
 	}
 
+static size_t end_of_first_sentence(string s)
+	{
+	size_t rval = 0;
+
+	while ( (rval = s.find_first_of('.', rval)) != string::npos )
+		{
+		if ( rval == s.size() - 1 )
+			// Period is at end of string.
+			return rval;
+
+		if ( isspace(s[rval + 1]) )
+			// Period has a space after it.
+			return rval;
+
+		// Period has some non-space character after it, keep looking.
+		++rval;
+		}
+
+	return rval;
+	}
+
 void BroDocObj::FormulateShortDesc()
 	{
 	if ( ! reST_doc_strings )
@@ -87,7 +108,7 @@ void BroDocObj::FormulateShortDesc()
 		{
 		// The short description stops at the first sentence or the
 		// first empty comment.
-		size_t end = it->find_first_of(".");
+		size_t end = end_of_first_sentence(*it);
 
 		if ( end == string::npos )
 			{
@@ -103,7 +124,7 @@ void BroDocObj::FormulateShortDesc()
 					break;
 					}
 				}
-			
+
 			if ( empty )
 				break;
 			}

testing/btest/Baseline/doc.autogen-reST-enums/autogen-reST-enums.rst

@@ -20,11 +20,11 @@ Options
 
 Types
 #####
-======================================= ======================================
-:bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look.
+======================================= ========================================
+:bro:type:`TestEnum1`: :bro:type:`enum` There's tons of ways an enum can look...
 
 :bro:type:`TestEnum2`: :bro:type:`enum` The final comma is optional
-======================================= ======================================
+======================================= ========================================
 
 Redefinitions
 #############

testing/btest/Baseline/doc.autogen-reST-example/example.rst

@@ -40,13 +40,15 @@ Options
 
 State Variables
 ###############
-=========================================================================== =======================================
+=========================================================================== ==================================================
 :bro:id:`Example::a_var`: :bro:type:`bool`                                  put some documentation for "a_var" here
 
 :bro:id:`Example::var_with_attr`: :bro:type:`count` :bro:attr:`&persistent`
 
 :bro:id:`Example::var_without_explicit_type`: :bro:type:`string`
-=========================================================================== =======================================
+
+:bro:id:`Example::dummy`: :bro:type:`string`                                The first.sentence for the summary text ends here.
+=========================================================================== ==================================================
 
 Types
 #####
@@ -156,6 +158,13 @@ State Variables
    :Type: :bro:type:`string`
    :Default: ``"this works"``
 
+.. bro:id:: Example::dummy
+
+   :Type: :bro:type:`string`
+
+   The first.sentence for the summary text ends here.  And this second
+   sentence doesn't show in the short description.
+
 Types
 #####
 .. bro:type:: Example::SimpleEnum