Añade un truco a la generación de Javadoc

Author: sio2sio2

docs/98.apendices/99.tools/10-vscode.html

@@ -1090,6 +1090,20 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
 <span class="nt">&lt;/build&gt;</span>
 </pre></div>
 </div>
+<div class="admonition tip">
+<p class="admonition-title">Truco</p>
+<p>Podemos modificar la ruta en la que se almacena la documentación:</p>
+<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;configuration&gt;</span>
+<span class="w">   </span><span class="nt">&lt;source&gt;</span>23<span class="nt">&lt;/source&gt;</span><span class="w"> </span><span class="cm">&lt;!-- Versión de Java. En mi caso, OpenJDK 23 --&gt;</span>
+<span class="w">   </span><span class="nt">&lt;show&gt;</span>private<span class="nt">&lt;/show&gt;</span><span class="w"> </span><span class="cm">&lt;!-- Muestra los atributos privados --&gt;</span>
+<span class="w">   </span><span class="nt">&lt;outputDirectory&gt;</span>${project.basedir}/docs<span class="nt">&lt;/outputDirectory&gt;</span>
+<span class="nt">&lt;/configuration&gt;</span>
+</pre></div>
+</div>
+<p>Esto provoca que se guarden los archivos en <code class="file docutils literal notranslate"><span class="pre">docs/apidocs</span></code>, lo cual
+puede ser muy conveniente si usamos un repositorio como GitHub y queremos
+publicar el <abbr title="Application Programming Interface">API</abbr>.</p>
+</div>
 <p>Hecho lo cual, podremos generar la documentación con la orden<a class="footnote-reference brackets" href="#id17" id="id9" role="doc-noteref"><span class="fn-bracket">[</span>8<span class="fn-bracket">]</span></a>:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>javadoc:javadoc
 </pre></div>
@@ -1127,8 +1141,8 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>clean:clean<span class="w"> </span>javadoc:javadoc<span class="w"> </span>-Pclean-javadoc-only
 </pre></div>
 </div>
-<div class="admonition tip">
-<p class="admonition-title">Truco</p>
+<div class="admonition hint">
+<p class="admonition-title">Consejo</p>
 <p>Si <a class="reference internal" href="#vscode-tasks"><span class="std std-ref">creamos una tarea</span></a> y le asociamos una
 <a class="reference internal" href="#vscode-atajos"><span class="std std-ref">combinación de teclas</span></a>, tal <a class="reference internal" href="#vscode-definir-jshell"><span class="std std-ref">como hicimos con
 jshell</span></a>. todo será muy cómodo.</p>

docs/_sources/98.apendices/99.tools/10-vscode.rst.txt

@@ -1110,6 +1110,20 @@ este modo:
           </plugins>
       </build>
       
+   .. tip:: Podemos modificar la ruta en la que se almacena la documentación:
+
+      .. code-block:: xml
+
+         <configuration>
+            <source>23</source> <!-- Versión de Java. En mi caso, OpenJDK 23 -->
+            <show>private</show> <!-- Muestra los atributos privados -->
+            <outputDirectory>${project.basedir}/docs</outputDirectory>
+         </configuration>
+
+      Esto provoca que se guarden los archivos en :file:`docs/apidocs`, lo cual
+      puede ser muy conveniente si usamos un repositorio como GitHub y queremos
+      publicar el |API|.
+
    Hecho lo cual, podremos generar la documentación con la orden\ [#]_:
 
    .. code-block:: console
@@ -1153,7 +1167,7 @@ este modo:
 
       $ mvn clean:clean javadoc:javadoc -Pclean-javadoc-only
 
-   .. tip:: Si :ref:`creamos una tarea <vscode-tasks>` y le asociamos una
+   .. hint:: Si :ref:`creamos una tarea <vscode-tasks>` y le asociamos una
       :ref:`combinación de teclas <vscode-atajos>`, tal :ref:`como hicimos con
       jshell <vscode-definir-jshell>`. todo será muy cómodo.
 
@@ -1216,6 +1230,7 @@ este modo:
 .. |JDK| replace:: :abbr:`JDK (Java Development Kit)`
 .. |IA| replace:: :abbr:`IA (Inteligencia Artificial)`
 .. |JAR| replace:: :abbr:`JAR (Java ARchive)`
+.. |API| replace:: :abbr:`API (Application Programming Interface)`
 
 .. _Brave: https://brave.com
 .. _XML Tools: https://marketplace.visualstudio.com/items?itemName=DotJoshJohnson.xml

docs/searchindex.js

@@ -1110,6 +1110,20 @@ este modo:
           </plugins>
       </build>
       
+   .. tip:: Podemos modificar la ruta en la que se almacena la documentación:
+
+      .. code-block:: xml
+
+         <configuration>
+            <source>23</source> <!-- Versión de Java. En mi caso, OpenJDK 23 -->
+            <show>private</show> <!-- Muestra los atributos privados -->
+            <outputDirectory>${project.basedir}/docs</outputDirectory>
+         </configuration>
+
+      Esto provoca que se guarden los archivos en :file:`docs/apidocs`, lo cual
+      puede ser muy conveniente si usamos un repositorio como GitHub y queremos
+      publicar el |API|.
+
    Hecho lo cual, podremos generar la documentación con la orden\ [#]_:
 
    .. code-block:: console
@@ -1153,7 +1167,7 @@ este modo:
 
       $ mvn clean:clean javadoc:javadoc -Pclean-javadoc-only
 
-   .. tip:: Si :ref:`creamos una tarea <vscode-tasks>` y le asociamos una
+   .. hint:: Si :ref:`creamos una tarea <vscode-tasks>` y le asociamos una
       :ref:`combinación de teclas <vscode-atajos>`, tal :ref:`como hicimos con
       jshell <vscode-definir-jshell>`. todo será muy cómodo.
 
@@ -1216,6 +1230,7 @@ este modo:
 .. |JDK| replace:: :abbr:`JDK (Java Development Kit)`
 .. |IA| replace:: :abbr:`IA (Inteligencia Artificial)`
 .. |JAR| replace:: :abbr:`JAR (Java ARchive)`
+.. |API| replace:: :abbr:`API (Application Programming Interface)`
 
 .. _Brave: https://brave.com
 .. _XML Tools: https://marketplace.visualstudio.com/items?itemName=DotJoshJohnson.xml