enhance documentation for edaxPlayPrint (#166)

* enhance documentation for edaxPlayPrint

* bump version

* fix comment syntax

* fix dart doc command

* fix txt comment

* add dart ci step

* fix step

Author: sensuikan1973

.github/workflows/api_doc.yaml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: dart-lang/setup-dart@v1
       - name: generate dart docs
-        run: dartdoc --output docs/
+        run: dart doc --output docs/
       - name: upload to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/dart_ci.yaml

@@ -111,6 +111,9 @@ jobs:
           cd example && dart pub get && cd ..
           dart example/example.dart
 
+      - name: generate dart docs
+        run: dart doc .
+
   dart_publish_dry_run:
     needs: dart_test
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,6 +1,10 @@
+# 3.1.1
+
+- enhance documentation of `edaxPlayPrint`.
+
 # 3.1.0
 
-- add `edaxPlayPrint`
+- add `edaxPlayPrint`.
 
 # 3.0.0
 

README.md

@@ -78,7 +78,7 @@ dart run pana
 #### document
 
 ```sh
-dartdoc && open doc/api/index.html
+dart doc . && open doc/api/index.html
 ```
 
 #### change libedax bin

example/pubspec.lock

@@ -77,7 +77,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "3.1.0"
+    version: "3.1.1"
   meta:
     dependency: transitive
     description:

example/pubspec.yaml

@@ -1,6 +1,6 @@
 ---
 name: libedax4dart_example
-version: 3.1.0-example
+version: 3.1.1-example
 publish_to: none
 
 environment:

lib/src/board.dart

@@ -87,17 +87,18 @@ class Board {
   /// get human readable board.
   ///
   /// example
-  ///
-  ///   A B C D E F G H <br>
-  /// 1 - - - - - - - - 1 <br>
-  /// 2 - - - - - - - - 2 <br>
-  /// 3 - - - - * - - - 3 <br>
-  /// 4 - - - * * * - - 4 <br>
-  /// 5 - - * * * * * - 5 <br>
-  /// 6 - - - * * * - - 6 <br>
-  /// 7 - - - - * - - - 7 <br>
-  /// 8 - - - - - - - - 8 <br>
+  /// ```txt
+  ///   A B C D E F G H
+  /// 1 - - - - - - - - 1
+  /// 2 - - - - - - - - 2
+  /// 3 - - - - * - - - 3
+  /// 4 - - - * * * - - 4
+  /// 5 - - * * * * * - 5
+  /// 6 - - - * * * - - 6
+  /// 7 - - - - * - - - 7
+  /// 8 - - - - - - - - 8
   ///   A B C D E F G H
+  /// ```
   String prettyString(final int currentColor) {
     final pStone =
         currentColor == TurnColor.black ? ColorChar.black : ColorChar.white;

lib/src/libedax.dart

@@ -395,5 +395,19 @@ class LibEdax {
   void edaxBookStopCountBestpath() => _bindings.edax_book_stop_count_bestpath();
 
   /// Print play.
+  ///
+  /// example: after play f5d6c5f4d3, play_print prints
+  /// ```txt
+  ///   A B C D E F G H            BLACK            A  B  C  D  E  F  G  H
+  /// 1 - - - - - - - - 1         0:00.012       1 |  |  |  |  |  |  |  |  | 1
+  /// 2 - - - . - - - - 2    6 discs   6 moves   2 |  |  |  |  |  |  |  |  | 2
+  /// 3 - - . * . - - - 3                        3 |  |  |  | 5|  |  |  |  | 3
+  /// 4 - . . * * O - - 4  ply  6 (55 empties)   4 |  |  |  |()|##| 4|  |  | 4
+  /// 5 - . * * O * . - 5    White's turn (O)    5 |  |  | 3|##|()| 1|  |  | 5
+  /// 6 - - - O - . - - 6                        6 |  |  |  | 2|  |  |  |  | 6
+  /// 7 - - - - - - - - 7    3 discs   8 moves   7 |  |  |  |  |  |  |  |  | 7
+  /// 8 - - - - - - - - 8         0:00.000       8 |  |  |  |  |  |  |  |  | 8
+  ///   A B C D E F G H            WHITE            A  B  C  D  E  F  G  H
+  /// ```
   void edaxPlayPrint() => _bindings.edax_play_print();
 }

pubspec.yaml

@@ -2,7 +2,7 @@
 # See: https://dart.dev/tools/pub/publishing
 
 name: libedax4dart
-version: 3.1.0
+version: 3.1.1
 description: Dart wrapper for libedax. With using libedax4dart, you can execute functions equivalent to edax.
 homepage: https://github.com/sensuikan1973/libedax4dart
 documentation: https://sensuikan1973.github.io/libedax4dart