Merge ec2803f into f91e524

core/src/main/java/org/mobilitydata/gtfsvalidator/notice/MixedCaseRecommendedFieldNotice.java

@@ -15,7 +15,43 @@
  * (e.g. “JFK Airport”). Abbreviations may be problematic for accessibility by screen reader
  * software and voice user interfaces.
  *
- * @see org.mobilitydata.gtfsvalidator.annotation.MixedCase
+ * <p>Good examples:
+ *
+ * <table style="table-layout:auto; width:auto;">
+ *   <tr>
+ *     <th><code>Field Text</code></th>
+ *     <th><code>Dataset</code></th>
+ *   </tr>
+ *   <tr>
+ *     <td>"Schwerin, Hauptbahnhof"</td>
+ *     <td><a href="http://vbb.de/vbbgtfs">Verkehrsverbund Berlin-Brandenburg</a></td>
+ *   </tr>
+ *    <tr>
+ *     <td>"Red Hook/Atlantic Basin"</td>
+ *     <td><a href="http://nycferry.connexionz.net/rtt/public/utility/gtfs.aspx">NYC Ferry</a></td>
+ *   </tr>
+ *   <tr>
+ *     <td>"Campo Grande Norte"</td>
+ *     <td><a href="https://gateway.carris.pt/gateway/gtfs/api/v2.8/GTFS">Carris</a></td>
+ *   </tr>
+ * </table>
+ *
+ * Bad examples:
+ *
+ * <table style="table-layout:auto; width:auto;">
+ *   <tr>
+ *     <th><code>Field Text</code></th>
+ *   </tr>
+ *   <tr>
+ *     <td>"GALLERIA MALL"</td>
+ *   </tr>
+ *   <tr>
+ *     <td>"3427 GG 17"</td>
+ *   </tr>
+ *   <tr>
+ *     <td>"21 Clark Rd Est"</td>
+ *   </tr>
+ * </table>
  */
 @GtfsValidationNotice(
     severity = WARNING,