adalal/gotenberg
1
0
Fork 0
mirror of https://github.com/gotenberg/gotenberg.git synced 2026-08-19 05:32:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: improve the godoc of all PDF engine packages

Browse Source
This commit is contained in:
Julien Neuhart
2024-02-24 15:14:45 +01:00
parent da326f1925
commit 2008ac5663
5 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pkg/modules/exiftool/doc.go
View File

@@ -1,8 +1,11 @@
// Package exiftool provides an implementation of the gotenberg.PdfEngine // Package exiftool provides an implementation of the gotenberg.PdfEngine
// interface using the ExifTool command-line tool. This package allows for reading and // interface using the ExifTool command-line tool. This package allows for:
// 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 // 1. The reading of metadata.
// specified using the EXIFTOOL_BIN_PATH environment variable. // 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. // See: https://exiftool.org.
package exiftool package exiftool

4
pkg/modules/libreoffice/pdfengine/doc.go
View File

@@ -1,4 +1,6 @@
// Package pdfengine provides a module which interacts with LibreOffice via the // Package pdfengine provides a module which interacts with LibreOffice via the
// UNO (Universal Network Objects) API and implements the gotenberg.PdfEngine // 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 package pdfengine

5
pkg/modules/pdfcpu/doc.go
View File

@@ -1,6 +1,7 @@
// Package pdfcpu provides an implementation of the gotenberg.PdfEngine // Package pdfcpu provides an implementation of the gotenberg.PdfEngine
// interface using the pdfcpu library. This package allows for the merging of // interface using the pdfcpu library. This package allows for:
// PDF files but does not support conversion to specific PDF formats. //
// 1. The merging of PDF files.
// //
// See: https://github.com/pdfcpu/pdfcpu. // See: https://github.com/pdfcpu/pdfcpu.
package pdfcpu package pdfcpu

10
pkg/modules/pdftk/doc.go
View File

@@ -1,8 +1,10 @@
// Package pdftk provides an implementation of the gotenberg.PdfEngine // Package pdftk provides an implementation of the gotenberg.PdfEngine
// interface using the PDFtk command-line tool. This package allows for the // interface using the PDFtk command-line tool. This package allows for:
// merging of PDF files but does not support conversion to specific PDF //
// formats. The path to the PDFtk binary must be specified using the // 1. The merging of PDF files.
// PDFTK_BIN_PATH environment variable. //
// The path to the PDFtk binary must be specified using the PDFTK_BIN_PATH
// environment variable.
// //
// See: https://gitlab.com/pdftk-java/pdftk. // See: https://gitlab.com/pdftk-java/pdftk.
package pdftk package pdftk

10
pkg/modules/qpdf/doc.go
View File

@@ -1,8 +1,10 @@
// Package qpdf provides an implementation of the gotenberg.PdfEngine // Package qpdf provides an implementation of the gotenberg.PdfEngine
// interface using the QPDF command-line tool. This package allows for the // interface using the QPDF command-line tool. This package allows for:
// merging of PDF files but does not support conversion to specific PDF //
// formats. The path to the QPDF binary must be specified using the // 1. The merging of PDF files.
// QPDK_BIN_PATH environment variable. //
// The path to the QPDF binary must be specified using the QPDK_BIN_PATH
// environment variable.
// //
// See: https://github.com/qpdf/qpdf. // See: https://github.com/qpdf/qpdf.
package qpdf package qpdf