From 2008ac5663515f456ea3f8c9690ff1af5d165d90 Mon Sep 17 00:00:00 2001
From: Julien Neuhart <neuhart.julien@gmail.com>
Date: Sat, 24 Feb 2024 15:14:45 +0100
Subject: [PATCH] chore: improve the godoc of all PDF engine packages

---
 pkg/modules/exiftool/doc.go              | 11 +++++++----
 pkg/modules/libreoffice/pdfengine/doc.go |  4 +++-
 pkg/modules/pdfcpu/doc.go                |  5 +++--
 pkg/modules/pdftk/doc.go                 | 10 ++++++----
 pkg/modules/qpdf/doc.go                  | 10 ++++++----
 5 files changed, 25 insertions(+), 15 deletions(-)

diff --git a/pkg/modules/exiftool/doc.go b/pkg/modules/exiftool/doc.go
index 7d9e750d..e9ae0a7f 100644
--- a/pkg/modules/exiftool/doc.go
+++ b/pkg/modules/exiftool/doc.go
@@ -1,8 +1,11 @@
 // Package exiftool provides an implementation of the gotenberg.PdfEngine
-// interface using the ExifTool command-line tool. This package allows for reading and
-// writing of metadata, but does not support the merging of PDF files
-// nor conversion to specific PDF formats. The path to the exiftool binary must be
-// specified using the EXIFTOOL_BIN_PATH environment variable.
+// interface using the ExifTool command-line tool. This package allows for:
+//
+// 1. The reading of metadata.
+// 2. The writing of metadata.
+//
+// The path to the exiftool binary must be specified using the
+// EXIFTOOL_BIN_PATH environment variable.
 //
 // See: https://exiftool.org.
 package exiftool
diff --git a/pkg/modules/libreoffice/pdfengine/doc.go b/pkg/modules/libreoffice/pdfengine/doc.go
index 4d81673f..de89cef7 100644
--- a/pkg/modules/libreoffice/pdfengine/doc.go
+++ b/pkg/modules/libreoffice/pdfengine/doc.go
@@ -1,4 +1,6 @@
 // Package pdfengine provides a module which interacts with LibreOffice via the
 // UNO (Universal Network Objects) API and implements the gotenberg.PdfEngine
-// interface.
+// interface. This package allows for:
+//
+// 1. The conversion to specific PDF formats.
 package pdfengine
diff --git a/pkg/modules/pdfcpu/doc.go b/pkg/modules/pdfcpu/doc.go
index 0ce40d41..f98fdd1c 100644
--- a/pkg/modules/pdfcpu/doc.go
+++ b/pkg/modules/pdfcpu/doc.go
@@ -1,6 +1,7 @@
 // Package pdfcpu provides an implementation of the gotenberg.PdfEngine
-// interface using the pdfcpu library. This package allows for the merging of
-// PDF files but does not support conversion to specific PDF formats.
+// interface using the pdfcpu library. This package allows for:
+//
+// 1. The merging of PDF files.
 //
 // See: https://github.com/pdfcpu/pdfcpu.
 package pdfcpu
diff --git a/pkg/modules/pdftk/doc.go b/pkg/modules/pdftk/doc.go
index 48992e92..3a01ae41 100644
--- a/pkg/modules/pdftk/doc.go
+++ b/pkg/modules/pdftk/doc.go
@@ -1,8 +1,10 @@
 // Package pdftk provides an implementation of the gotenberg.PdfEngine
-// interface using the PDFtk command-line tool. This package allows for the
-// merging  of PDF files but does not support conversion to specific PDF
-// formats. The path to the PDFtk binary must be specified using the
-// PDFTK_BIN_PATH environment variable.
+// interface using the PDFtk command-line tool. This package allows for:
+//
+// 1. The merging of PDF files.
+//
+// The path to the PDFtk binary must be specified using the PDFTK_BIN_PATH
+// environment variable.
 //
 // See: https://gitlab.com/pdftk-java/pdftk.
 package pdftk
diff --git a/pkg/modules/qpdf/doc.go b/pkg/modules/qpdf/doc.go
index 4c90b711..31f61b36 100644
--- a/pkg/modules/qpdf/doc.go
+++ b/pkg/modules/qpdf/doc.go
@@ -1,8 +1,10 @@
 // Package qpdf provides an implementation of the gotenberg.PdfEngine
-// interface using the QPDF command-line tool. This package allows for the
-// merging  of PDF files but does not support conversion to specific PDF
-// formats. The path to the QPDF binary must be specified using the
-// QPDK_BIN_PATH environment variable.
+// interface using the QPDF command-line tool. This package allows for:
+//
+// 1. The merging of PDF files.
+//
+// The path to the QPDF binary must be specified using the QPDK_BIN_PATH
+// environment variable.
 //
 // See: https://github.com/qpdf/qpdf.
 package qpdf