1 files changed, 24 insertions, 0 deletions
diff --git a/sorsyl/lib/syllabifier.mli b/sorsyl/lib/syllabifier.mli
new file mode 100644
index 0000000..e40feeb
--- /dev/null
+++ b/sorsyl/lib/syllabifier.mli
@@ -0,0 +1,24 @@
+(** Syllabifier module for segmenting words into syllables using sonority *)
+
+(** Result of syllabification *)
+type syllabified = {
+  word : string;           (** Original orthographic word *)
+  ipa : string;            (** Original IPA transcription *)
+  lang : string;           (** Language code *)
+  clean_ipa : string;      (** Cleaned IPA without diacritics *)
+  syllables : Syllable.t list;  (** List of syllables *)
+}
+
+(** Syllabify a word given its IPA transcription 
+    @param sonority The sonority calculator
+    @param ipa The IPA transcription of the word
+    @param word The orthographic form of the word
+    @param lang The language code
+    @return The syllabified result
+*)
+val syllabify : 
+  sonority:Sonority.t -> 
+  ipa:string -> 
+  word:string -> 
+  lang:string -> 
+  syllabified
+\ No newline at end of file