add supported formalisms to serializers' documentation

mtf90 · mtf90 · commit 1e67aff1bb3e · 2026-02-16T14:36:47.000+01:00
diff --git a/serialization/aut/src/main/java/module-info.java b/serialization/aut/src/main/java/module-info.java
@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.simple.SimpleAutomaton;
+
 /**
  * This module contains (de-) serializers for the AUT format. For further information about the AUT format, see <a
- * href="http://cadp.inria.fr/man/aut.html">http://cadp.inria.fr/man/aut.html</a>.
+ * href="http://cadp.inria.fr/man/aut.html">http://cadp.inria.fr/man/aut.html</a>. Currently, this module supports
+ * (de-)serialization of {@link SimpleAutomaton}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/ba/src/main/java/module-info.java b/serialization/ba/src/main/java/module-info.java
@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.FiniteStateAcceptor;
+
 /**
  * This module contains (de-) serializers for the BA format. For further information about the BA format, see <a
  * href="https://languageinclusion.org/doku.php?id=tools#the_ba_format">https://languageinclusion.org/doku.php?id=tools#the_ba_format</a>.
+ * Currently, this module supports (de-)serialization of {@link FiniteStateAcceptor}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/dot/src/main/java/module-info.java b/serialization/dot/src/main/java/module-info.java
@@ -14,9 +14,21 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.UniversalAutomaton;
+import net.automatalib.automaton.fsa.DFA;
+import net.automatalib.automaton.mmlt.MMLT;
+import net.automatalib.automaton.transducer.MealyMachine;
+import net.automatalib.automaton.transducer.MooreMachine;
+import net.automatalib.graph.ContextFreeModalProcessSystem;
+import net.automatalib.graph.Graph;
+import net.automatalib.ts.modal.ModalTransitionSystem;
+
 /**
  * This module contains (de-) serializers for the DOT format. For further information about the DOT format, see <a
- * href="https://graphviz.org/doc/info/lang.html">https://graphviz.org/doc/info/lang.html</a>.
+ * href="https://graphviz.org/doc/info/lang.html">https://graphviz.org/doc/info/lang.html</a>. Currently, this module
+ * supports (de-)serialization of generic {@link UniversalAutomaton}s (such as {@link DFA}s, {@link MealyMachine}s, and
+ * {@link MooreMachine}s), {@link Graph}s, {@link ModalTransitionSystem}s, {@link MMLT}s, and
+ * {@link ContextFreeModalProcessSystem}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/etf/src/main/java/module-info.java b/serialization/etf/src/main/java/module-info.java
@@ -14,10 +14,14 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.DFA;
+import net.automatalib.automaton.transducer.MealyMachine;
+
 /**
  * This module contains serializers for LTSmin's Enumerated Table Format (ETF). For further information about the ETF
  * format, see <a
- * href="https://ltsmin.utwente.nl/assets/man/etf.html">https://ltsmin.utwente.nl/assets/man/etf.html</a>.
+ * href="https://ltsmin.utwente.nl/assets/man/etf.html">https://ltsmin.utwente.nl/assets/man/etf.html</a>. Currently,
+ * this module supports serialization of {@link DFA}s and {@link MealyMachine}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/fsm/src/main/java/module-info.java b/serialization/fsm/src/main/java/module-info.java
@@ -14,10 +14,15 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.DFA;
+import net.automatalib.automaton.transducer.MealyMachine;
+
 /**
  * This module contains deserializers for the Finite State Machine (FSM) format as used by LTSmin. For further
  * information about the FSM format, see the <a
- * href="https://mcrl2.org/web/user_manual/tools/lts.html#language-fsm-lts">mcrl2 documentation</a>.
+ * href="https://mcrl2.org/web/user_manual/tools/lts.html#language-fsm-lts">mcrl2 documentation</a>. Currently, this
+ * module supports deserialization of {@link DFA}s and {@link MealyMachine}s (both with alternating and synchronous
+ * input/ouput symbols).
  * <p>
  * Note that this format differs from the identically named FSM format of <a
  * href="https://github.com/katef/libfsm">libfsm</a>.
diff --git a/serialization/learnlibv2/src/main/java/module-info.java b/serialization/learnlibv2/src/main/java/module-info.java
@@ -14,9 +14,11 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.DFA;
+
 /**
  * This module contains (de-) serializers for the legacy LearnLibV2 format. This is a custom text format used by
- * LearnLib.
+ * LearnLib. Currently, this module supports (de-)serialization of {@link DFA}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/mata/src/main/java/module-info.java b/serialization/mata/src/main/java/module-info.java
@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.NFA;
+
 /**
  * This module contains (de-) serializers for the Mata automaton format. This format is used by the <a
- * href="https://doi.org/10.1007/978-3-031-57249-4_7">Mata Automata Library</a>.
+ * href="https://doi.org/10.1007/978-3-031-57249-4_7">Mata Automata Library</a>. Currently, this module supports
+ * (de-)serialization of {@link NFA}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/saf/src/main/java/module-info.java b/serialization/saf/src/main/java/module-info.java
@@ -14,9 +14,13 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.DFA;
+import net.automatalib.automaton.fsa.NFA;
+import net.automatalib.automaton.transducer.MealyMachine;
+
 /**
  * This module contains (de-) serializers for the Simple Automaton Format (SAF). SAF is a custom, human-readable text
- * format.
+ * format. Currently, this module supports (de-)serialization of {@link DFA}s, {@link NFA}s, and {@link MealyMachine}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
diff --git a/serialization/taf/src/main/java/module-info.java b/serialization/taf/src/main/java/module-info.java
@@ -14,8 +14,12 @@
  * limitations under the License.
  */
 
+import net.automatalib.automaton.fsa.DFA;
+import net.automatalib.automaton.transducer.MealyMachine;
+
 /**
  * This module contains (de-) serializers for the Textual Automaton Format (TAF). TAF is a custom bitstream format.
+ * Currently, this module supports (de-)serialization of {@link DFA}s and {@link MealyMachine}s.
  * <p>
  * This module is provided by the following Maven dependency:
  * <pre>
