improve documentation format

This commit is contained in:
Hervé Boutemy 2021-01-09 21:51:14 +01:00 committed by Oleg Kalnichevski
parent 6a02e818ff
commit 3b0a7aeee8
8 changed files with 138 additions and 11 deletions

View File

@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see information on the Apache Software Foundation, please see
<http://www.apache.org />. <http://www.apache.org />.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent> <parent>
<groupId>org.apache.httpcomponents.client5</groupId> <groupId>org.apache.httpcomponents.client5</groupId>
@ -34,7 +34,6 @@
<name>Apache HttpClient Cache</name> <name>Apache HttpClient Cache</name>
<inceptionYear>2010</inceptionYear> <inceptionYear>2010</inceptionYear>
<description>Apache HttpComponents HttpClient Cache</description> <description>Apache HttpComponents HttpClient Cache</description>
<url>https://hc.apache.org/httpcomponents-client-5.0.x/</url>
<packaging>jar</packaging> <packaging>jar</packaging>
<properties> <properties>
@ -127,6 +126,7 @@
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>index</report>
<report>dependencies</report> <report>dependencies</report>
<report>dependency-info</report> <report>dependency-info</report>
<report>summary</report> <report>summary</report>

View File

@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see information on the Apache Software Foundation, please see
<http://www.apache.org />. <http://www.apache.org />.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent> <parent>
<groupId>org.apache.httpcomponents.client5</groupId> <groupId>org.apache.httpcomponents.client5</groupId>
@ -34,7 +34,6 @@
<name>Apache HttpClient Fluent</name> <name>Apache HttpClient Fluent</name>
<inceptionYear>2011</inceptionYear> <inceptionYear>2011</inceptionYear>
<description>Apache HttpComponents Client Fluent</description> <description>Apache HttpComponents Client Fluent</description>
<url>https://hc.apache.org/httpcomponents-client-5.0.x/</url>
<packaging>jar</packaging> <packaging>jar</packaging>
<properties> <properties>
@ -120,6 +119,7 @@
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>index</report>
<report>dependencies</report> <report>dependencies</report>
<report>dependency-info</report> <report>dependency-info</report>
<report>summary</report> <report>summary</report>

View File

@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see information on the Apache Software Foundation, please see
<http://www.apache.org />. <http://www.apache.org />.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent> <parent>
<groupId>org.apache.httpcomponents.client5</groupId> <groupId>org.apache.httpcomponents.client5</groupId>
@ -33,7 +33,6 @@
<artifactId>httpclient5-testing</artifactId> <artifactId>httpclient5-testing</artifactId>
<name>Apache HttpClient Integration Tests</name> <name>Apache HttpClient Integration Tests</name>
<description>Apache HttpClient integration tests</description> <description>Apache HttpClient integration tests</description>
<url>https://hc.apache.org/httpcomponents-client-5.0.x/</url>
<packaging>jar</packaging> <packaging>jar</packaging>
<properties> <properties>
@ -108,6 +107,7 @@
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>index</report>
<report>dependencies</report> <report>dependencies</report>
<report>dependency-info</report> <report>dependency-info</report>
<report>summary</report> <report>summary</report>

View File

@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see information on the Apache Software Foundation, please see
<http://www.apache.org />. <http://www.apache.org />.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent> <parent>
<groupId>org.apache.httpcomponents.client5</groupId> <groupId>org.apache.httpcomponents.client5</groupId>
@ -33,7 +33,6 @@
<artifactId>httpclient5-win</artifactId> <artifactId>httpclient5-win</artifactId>
<name>Apache HttpClient Windows features</name> <name>Apache HttpClient Windows features</name>
<description>Apache HttpClient Windows specific functionality</description> <description>Apache HttpClient Windows specific functionality</description>
<url>https://hc.apache.org/httpcomponents-client-5.0.x/</url>
<packaging>jar</packaging> <packaging>jar</packaging>
<properties> <properties>
@ -89,6 +88,7 @@
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>index</report>
<report>dependencies</report> <report>dependencies</report>
<report>dependency-info</report> <report>dependency-info</report>
<report>summary</report> <report>summary</report>

View File

@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see information on the Apache Software Foundation, please see
<http://www.apache.org />. <http://www.apache.org />.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent> <parent>
<groupId>org.apache.httpcomponents.client5</groupId> <groupId>org.apache.httpcomponents.client5</groupId>
@ -33,7 +33,6 @@
<artifactId>httpclient5</artifactId> <artifactId>httpclient5</artifactId>
<name>Apache HttpClient</name> <name>Apache HttpClient</name>
<description>Apache HttpComponents Client</description> <description>Apache HttpComponents Client</description>
<url>https://hc.apache.org/httpcomponents-client-5.0.x/</url>
<packaging>jar</packaging> <packaging>jar</packaging>
<properties> <properties>
@ -166,6 +165,7 @@
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>index</report>
<report>dependencies</report> <report>dependencies</report>
<report>dependency-info</report> <report>dependency-info</report>
<report>summary</report> <report>summary</report>

26
pom.xml
View File

@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see information on the Apache Software Foundation, please see
<http://www.apache.org />. <http://www.apache.org />.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent> <parent>
<groupId>org.apache.httpcomponents</groupId> <groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcomponents-parent</artifactId> <artifactId>httpcomponents-parent</artifactId>
@ -327,16 +327,40 @@
<version>${hc.javadoc.version}</version> <version>${hc.javadoc.version}</version>
<configuration> <configuration>
<quiet>true</quiet> <quiet>true</quiet>
<notimestamp>true</notimestamp>
<links> <links>
<link>https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5/apidocs/</link> <link>https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5/apidocs/</link>
<link>https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5-h2/apidocs/</link> <link>https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5-h2/apidocs/</link>
<link>${project.url}/httpclient5/apidocs/</link> <link>${project.url}/httpclient5/apidocs/</link>
</links> </links>
<groups>
<group>
<title>Apache HttpClient</title>
<packages>org.apache.hc.client5.http*</packages>
</group>
<group>
<title>Apache HttpClient Cache</title>
<packages>org.apache.hc.client5.http.cache*:org.apache.hc.client5.http.impl.cache*:org.apache.hc.client5.http.schedule:org.apache.hc.client5.http.impl.schedule*</packages>
</group>
<group>
<title>Apache HttpClient Fluent</title>
<packages>org.apache.hc.client5.http.fluent*</packages>
</group>
<group>
<title>Apache HttpClient Testing</title>
<packages>org.apache.hc.client5.testing*</packages>
</group>
<group>
<title>Apache HttpClient Windows features</title>
<packages>org.apache.hc.client5.http.impl.win*</packages>
</group>
</groups>
</configuration> </configuration>
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>javadoc</report> <report>javadoc</report>
<report>aggregate</report>
</reports> </reports>
</reportSet> </reportSet>
</reportSets> </reportSets>

View File

@ -0,0 +1,20 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
@import url("/css/hc-maven.css");

83
src/site/site.xml Normal file
View File

@ -0,0 +1,83 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/DECORATION/1.6.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.6.0 http://maven.apache.org/xsd/decoration-1.6.0.xsd"
name="Apache HttpComponents Client">
<!-- N.B. all non-body elements are automatically inherited -->
<skin>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>maven-site-skin</artifactId>
<version>1.1</version>
</skin>
<bannerLeft>
<name>Apache</name>
<src>http://www.apache.org/images/asf_logo_wide.gif</src>
<href>http://www.apache.org/</href>
</bannerLeft>
<bannerRight>
<name>HttpComponents</name>
<src>http://hc.apache.org/images/logos/httpcomponents.png</src>
<href>http://hc.apache.org/</href>
</bannerRight>
<body>
<!-- N.B. body links are automatically inherited -->
<links>
<item name="Apache" href="http://www.apache.org/"/>
<item name="HttpComponents" href="http://hc.apache.org/index.html"/>
</links>
<!-- inherited -->
<menu ref="parent" inherit="bottom"/>
<menu ref="modules" inherit="bottom"/>
<menu ref="reports" inherit="bottom"/>
<menu name="ASF" inherit="bottom">
<item name="ASF Home Page" href="http://www.apache.org"/>
<item name="Foundation" href="http://www.apache.org/foundation/"/>
<item name="Sponsor Apache" href="http://www.apache.org/foundation/sponsorship.html"/>
<item name="Thanks" href="http://www.apache.org/foundation/thanks.html"/>
</menu>
</body>
<!-- inherited -->
<poweredBy>
<!-- Add ApacheCon logo -->
<logo name="ApacheCon" href="http://www.apache.org/events/current-event.html"
img="http://www.apache.org/events/current-event-125x125.png"/>
<!-- Keep the default logo as well -->
<logo name="Maven" href="http://maven.apache.org/"
img="http://maven.apache.org/images/logos/maven-feather.png"/>
</poweredBy>
<!-- inherited -->
<custom>
<footer>
<div class="xleft">Apache HttpComponents, Commons HttpClient, Apache, the Apache feather logo, and the Apache HttpComponents project logo are trademarks of The Apache Software Foundation.</div>
<br/>
<div class="xleft">All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</footer>
</custom>
</project>