Add "nodoc" annotation

.release-notes/nodoc.md

@@ -0,0 +1,7 @@
+##  Add "nodoc" annotation
+
+The can be used to control the pony compilers documentation generation, any structure that can have a docstring (except packages) can be annotated with \nodoc\ to prevent documentation from being generated.
+
+This replaces a hack that has existed in the documentation generation system for several years to filter out items that were "for testing" by looking for Test and _Test at the beginning of the name as well as providing UnitTest or TestList.
+
+Note that the "should we include this package" hack to filter oupackages called "test" and "builtin_test" still exists for the timbeing until we have further discussion.

CHANGELOG.md

@@ -19,6 +19,7 @@ All notable changes to the Pony compiler and standard library will be documented
 - Remove library mode option from ponyc ([PR #3975](https://github.com/ponylang/ponyc/pull/3975))
 - Change `builtin/AsioEventNotify` from an interface to a trait ([PR #3973](https://github.com/ponylang/ponyc/pull/3973))
 - Don't allow interfaces to have private methods ([PR #3973](https://github.com/ponylang/ponyc/pull/3973))
+- Remove hack that prevented documentation generation for "test classes" ([PR #3978](https://github.com/ponylang/ponyc/pull/3978))
 
 ## [0.46.0] - 2022-01-16
 

packages/buffered/_test.pony

@@ -1,6 +1,6 @@
 use "ponytest"
 
-actor Main is TestList
+actor \nodoc\ Main is TestList
   new create(env: Env) => PonyTest(env, this)
   new make() => None
 
@@ -9,7 +9,7 @@ actor Main is TestList
     test(_TestReader)
     test(_TestWriter)
 
-class iso _TestReader is UnitTest
+class \nodoc\ iso _TestReader is UnitTest
   """
   Test adding to and reading from a Reader.
   """
@@ -198,7 +198,7 @@ class iso _TestReader is UnitTest
     // the last byte is consumed by the reader
     h.assert_eq[USize](b.size(), 0)
 
-class iso _TestWriter is UnitTest
+class \nodoc\ iso _TestWriter is UnitTest
   """
   Test writing to and reading from a Writer.
   """