build: maven-javadoc-plugin для публичного API core
- Корневой pom: версия 3.12.0 + pluginManagement (outputDirectory закреплён
на target/site, цель — только javadoc:javadoc, лайфцикл verify не меняется).
- wordpdf-core объявляет плагин без executions; wordpdf-app javadoc не генерирует.
- Правки javadoc-комментарий по ошибкам doclint: {@code <=} в ChartImageHandler,
полные имена {@link ru.pjandro.wordpdf.ConversionException} в DocToDocx.
This commit is contained in:
@@ -39,6 +39,8 @@
|
||||
|
||||
<!-- Покрытие: последняя стабильная на Maven Central -->
|
||||
<jacoco.version>0.8.15</jacoco.version>
|
||||
<!-- Javadoc публичного API core: последняя стабильная на Maven Central -->
|
||||
<maven-javadoc-plugin.version>3.12.0</maven-javadoc-plugin.version>
|
||||
<!-- Пустой дефолт: при -Djacoco.skip=true surefire не споткнётся
|
||||
о неразвёрнутый @{argLine}; prepare-agent перезаписывает его -->
|
||||
<argLine></argLine>
|
||||
@@ -156,6 +158,27 @@
|
||||
<artifactId>maven-jar-plugin</artifactId>
|
||||
<version>3.5.1</version>
|
||||
</plugin>
|
||||
<!-- Javadoc: генерация только по явной цели javadoc:javadoc
|
||||
(объявлен без executions в wordpdf-core) — поведение
|
||||
mvn clean verify не затрагивает. -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>${maven-javadoc-plugin.version}</version>
|
||||
<configuration>
|
||||
<encoding>UTF-8</encoding>
|
||||
<doclint>all,-missing</doclint>
|
||||
<show>protected</show>
|
||||
<nohelp>true</nohelp>
|
||||
<windowtitle>wordpdf-core API</windowtitle>
|
||||
<doctitle>wordpdf-core API (javadoc)</doctitle>
|
||||
<!-- пин вывода: у 3.12.0 дефолт target/reports (параметр
|
||||
outputDirectory, поверх него плагин сам кладёт apidocs/),
|
||||
фиксируем target/site → target/site/apidocs — оттуда
|
||||
копирует задача docs-deploy -->
|
||||
<outputDirectory>${project.build.directory}/site</outputDirectory>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-pmd-plugin</artifactId>
|
||||
|
||||
@@ -143,6 +143,15 @@
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<!-- Javadoc публичного API модуля (цель javadoc:javadoc, задача mise
|
||||
docs-javadoc; результат target/site/apidocs попадает на сайт
|
||||
документации). Без executions: в лайфцикл не вмешивается.
|
||||
wordpdf-app javadoc не генерирует — единственного public-класса
|
||||
WordPdfApplication недостаточно для раздела документации. -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
|
||||
@@ -30,10 +30,10 @@ import java.nio.ByteBuffer;
|
||||
*
|
||||
* Медиа документов (фото/скрины) — не наши части, но и для них штатный путь
|
||||
* дорог: {@code PictureCompression.compress} декодирует полный растр (ImageIO)
|
||||
* ДО любых решений, а для не-JPEG без кропа с ppi <= threshold (и без размера
|
||||
* ДО любых решений, а для не-JPEG без кропа с ppi {@code <=} threshold (и без размера
|
||||
* в макете) результат всегда null — декод впустую. Здесь такое решение
|
||||
* принимается по 26 байтам заголовка (PNG/GIF/BMP), растр не декодируется
|
||||
* вовсе. JPEG сознательно не ускоряем: Word при ppi <= threshold перекодирует
|
||||
* вовсе. JPEG сознательно не ускоряем: Word при ppi {@code <=} threshold перекодирует
|
||||
* его «для размера», вывод должен остаться побайтно прежним.
|
||||
*
|
||||
* Регрессии — WordPdfConverterTest#chartMedia_notDownsampled,
|
||||
|
||||
@@ -67,7 +67,7 @@ import java.util.regex.Pattern;
|
||||
*
|
||||
* <p>Контракт ошибок: любой некорректный вход (не CFB, не Word, шифрование,
|
||||
* Word 6/95, обрезка, цикл в цепочках, страницы сверх лимита) —
|
||||
* {@link ConversionException}.</p>
|
||||
* {@link ru.pjandro.wordpdf.ConversionException}.</p>
|
||||
*/
|
||||
public final class DocToDocx {
|
||||
|
||||
@@ -122,7 +122,8 @@ public final class DocToDocx {
|
||||
* @param docBytes контейнер Word 97–2003
|
||||
* @param maxMb лимит размера входа (МБ) — из него порог пиксельной
|
||||
* площади растра ({@code WordPdfValidator.maxImagePixels})
|
||||
* @throws ConversionException на некорректном/зашифрованном/чужом входе
|
||||
* @throws ru.pjandro.wordpdf.ConversionException
|
||||
* на некорректном/зашифрованном/чужом входе
|
||||
*/
|
||||
public static byte[] convert(byte[] docBytes, long maxMb) {
|
||||
long maxPixels = WordPdfValidator.maxImagePixels(maxMb);
|
||||
@@ -226,7 +227,8 @@ public final class DocToDocx {
|
||||
* Нижняя оценка числа страниц бинарного .doc (кэш PageCount + явные
|
||||
* разрывы) — для {@code WordPdfValidator.checkPageCountDoc}.
|
||||
*
|
||||
* @throws ConversionException на некорректном/зашифрованном/чужом входе
|
||||
* @throws ru.pjandro.wordpdf.ConversionException
|
||||
* на некорректном/зашифрованном/чужом входе
|
||||
*/
|
||||
public static int countPages(byte[] docBytes) {
|
||||
return DocFile.open(docBytes).countPages();
|
||||
|
||||
Reference in New Issue
Block a user