Merge pull request #749 from wader/doc-regen

doc,moc3,caff: Add author and regenerate docs
wader · Aug 21, 2023 · 7189798 · 7189798
2 parents 2eae4c2 + f15f9bc
commit 7189798
Show file tree

Hide file tree

Showing 7 changed files with 1,201 additions and 1,146 deletions.
diff --git a/README.md b/README.md
@@ -107,7 +107,7 @@ jsonl,
 macho_fat,
 [markdown](doc/formats.md#markdown),
 [matroska](doc/formats.md#matroska),
-moc3,
+[moc3](doc/formats.md#moc3),
 [mp3](doc/formats.md#mp3),
 mp3_frame,
 mp3_frame_vbri,

diff --git a/doc/formats.md b/doc/formats.md
@@ -77,7 +77,7 @@
 |`macho_fat`                                             |Fat&nbsp;Mach-O&nbsp;macOS&nbsp;executable&nbsp;(multi-architecture)                                         |<sub>`macho`</sub>|
 |[`markdown`](#markdown)                                 |Markdown                                                                                                     |<sub></sub>|
 |[`matroska`](#matroska)                                 |Matroska&nbsp;file                                                                                           |<sub>`aac_frame` `av1_ccr` `av1_frame` `avc_au` `avc_dcr` `flac_frame` `flac_metadatablocks` `hevc_au` `hevc_dcr` `image` `mp3_frame` `mpeg_asc` `mpeg_pes_packet` `mpeg_spu` `opus_packet` `vorbis_packet` `vp8_frame` `vp9_cfm` `vp9_frame`</sub>|
-|`moc3`                                                  |MOC3&nbsp;file                                                                                               |<sub></sub>|
+|[`moc3`](#moc3)                                         |MOC3&nbsp;file                                                                                               |<sub></sub>|
 |[`mp3`](#mp3)                                           |MP3&nbsp;file                                                                                                |<sub>`id3v2` `id3v1` `id3v11` `apev2` `mp3_frame`</sub>|
 |`mp3_frame`                                             |MPEG&nbsp;audio&nbsp;layer&nbsp;3&nbsp;frame                                                                 |<sub>`mp3_frame_tags`</sub>|
 |`mp3_frame_vbri`                                        |MP3&nbsp;frame&nbsp;Fraunhofer&nbsp;encoder&nbsp;variable&nbsp;bitrate&nbsp;tag                              |<sub></sub>|
@@ -510,6 +510,9 @@ Decode value as caff
 ... | caff({uncompress:true})
 ```
 
+### Authors
+- [@ronsor](https://github.com/ronsor)
+
 ## cbor
 
 ### Convert represented value to JSON
@@ -750,6 +753,11 @@ $ fq 'grep_by(.id == "Tracks") | matroska_path' file.mkv
 - https://www.matroska.org/technical/codec_specs.html
 - https://wiki.xiph.org/MatroskaOpus
 
+## moc3
+
+### Authors
+- [@ronsor](https://github.com/ronsor)
+
 ## mp3
 
 ### Options

diff --git a/doc/formats.svg b/doc/formats.svg
diff --git a/format/caff/caff.go b/format/caff/caff.go
@@ -3,6 +3,7 @@ package caff
 import (
 	"bytes"
 	"compress/flate"
+	"embed"
 	"io"
 
 	"github.com/wader/fq/format"
@@ -12,6 +13,9 @@ import (
 	"github.com/wader/fq/pkg/scalar"
 )
 
+//go:embed caff.md
+var caffFS embed.FS
+
 var probeGroup decode.Group
 
 func init() {
@@ -28,6 +32,7 @@ func init() {
 				{Groups: []*decode.Group{format.Probe}, Out: &probeGroup},
 			},
 		})
+	interp.RegisterFS(caffFS)
 }
 
 const (

diff --git a/format/caff/caff.md b/format/caff/caff.md
@@ -0,0 +1,2 @@
+### Authors
+- [@ronsor](https://github.com/ronsor)
diff --git a/format/moc3/moc3.go b/format/moc3/moc3.go
@@ -3,12 +3,17 @@ package moc3
 // https://github.com/OpenL2D/moc3ingbird/blob/master/src/moc3.hexpat
 
 import (
+	"embed"
+
 	"github.com/wader/fq/format"
 	"github.com/wader/fq/pkg/decode"
 	"github.com/wader/fq/pkg/interp"
 	"github.com/wader/fq/pkg/scalar"
 )
 
+//go:embed moc3.md
+var moc3FS embed.FS
+
 func init() {
 	interp.RegisterFormat(
 		format.MOC3,
@@ -17,6 +22,7 @@ func init() {
 			Groups:      []*decode.Group{format.Probe},
 			DecodeFn:    decodeMOC3,
 		})
+	interp.RegisterFS(moc3FS)
 }
 
 const (

diff --git a/format/moc3/moc3.md b/format/moc3/moc3.md
@@ -0,0 +1,2 @@
+### Authors
+- [@ronsor](https://github.com/ronsor)