Skip to content

Commit 12115ca

Browse files
committed
Correcciones a Javadoc
1 parent 590a701 commit 12115ca

File tree

5 files changed

+46
-5
lines changed

5 files changed

+46
-5
lines changed

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

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
923923
Además, <a class="reference internal" href="#code-runner"><span class="std std-ref">Code Runner</span></a> no atenderá a la jerarquía de directorios creados por
924924
<a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-dependency">Project Manager for Java</a>.</p>
925925
</div>
926-
<p>Además de estas extensiones puede interesarnos añadir configuración adicional:</p>
926+
<p id="vscode-java-settings">Además de estas extensiones puede interesarnos añadir configuración adicional:</p>
927927
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
928928
<span class="w"> </span><span class="nt">&quot;files.exclude&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
929929
<span class="w"> </span><span class="nt">&quot;bin/&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="c1">// No vemos el directorio de compilaciones (Project Manager)</span>
@@ -1055,7 +1055,8 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10551055
<div class="admonition note">
10561056
<p class="admonition-title">Nota</p>
10571057
<p>Y, posiblemente, también nos interese modificar el valor de
1058-
<cite>files.exclude</cite> para incluir <code class="file docutils literal notranslate"><span class="pre">target/</span></code></p>
1058+
<cite>files.exclude</cite> en <a class="reference internal" href="#vscode-java-settings"><span class="std std-ref">settings.json</span></a> para
1059+
incluir <code class="file docutils literal notranslate"><span class="pre">target/</span></code></p>
10591060
</div>
10601061
<p>Además, es probable que queramos en algún momento generar documentación del
10611062
proyecto con <a class="reference external" href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html">Javadoc</a> para ello debemos añadir al archivo <code class="file docutils literal notranslate"><span class="pre">pom.xml</span></code> el
@@ -1067,6 +1068,10 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10671068
<span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>maven-javadoc-plugin<span class="nt">&lt;/artifactId&gt;</span>
10681069
<span class="w"> </span><span class="cm">&lt;!-- La última versión puede consultarse en el repositorio de Maven --&gt;</span>
10691070
<span class="w"> </span><span class="nt">&lt;version&gt;</span>3.10.0<span class="nt">&lt;/version&gt;</span>
1071+
<span class="w"> </span><span class="nt">&lt;configuration&gt;</span>
1072+
<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>
1073+
<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>
1074+
<span class="w"> </span><span class="nt">&lt;/configuracion&gt;</span>
10701075
<span class="w"> </span><span class="nt">&lt;/plugin&gt;</span>
10711076
<span class="w"> </span><span class="nt">&lt;/plugins&gt;</span>
10721077
<span class="nt">&lt;/build&gt;</span>
@@ -1077,6 +1082,14 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10771082
</pre></div>
10781083
</div>
10791084
<p>Se almacenará dentro de <code class="file docutils literal notranslate"><span class="pre">target/</span></code>.</p>
1085+
<div class="admonition caution">
1086+
<p class="admonition-title">Prudencia</p>
1087+
<p>Si comprueba que la documentación no refleja algún cambio que se
1088+
haya hecho en los comentarios, puede ejecutar a mano:</p>
1089+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>clean
1090+
</pre></div>
1091+
</div>
1092+
</div>
10801093
<div class="admonition seealso">
10811094
<p class="admonition-title">Ver también</p>
10821095
<p>Para más información, consulte <a class="reference external" href="https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html">las explicaciones de Maven al

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -916,6 +916,8 @@ mientras que en *Windows* podemos utilizar los instalables que nos ofrece
916916
Además, :ref:`Code Runner <code-runner>` no atenderá a la jerarquía de directorios creados por
917917
`Project Manager for Java`_.
918918

919+
.. _vscode-java-settings:
920+
919921
Además de estas extensiones puede interesarnos añadir configuración adicional:
920922

921923
.. code-block:: json
@@ -1069,7 +1071,8 @@ este modo:
10691071
}
10701072
10711073
.. note:: Y, posiblemente, también nos interese modificar el valor de
1072-
`files.exclude` para incluir :file:`target/`
1074+
`files.exclude` en :ref:`settings.json <vscode-java-settings>` para
1075+
incluir :file:`target/`
10731076

10741077
Además, es probable que queramos en algún momento generar documentación del
10751078
proyecto con Javadoc_ para ello debemos añadir al archivo :file:`pom.xml` el
@@ -1084,6 +1087,10 @@ este modo:
10841087
<artifactId>maven-javadoc-plugin</artifactId>
10851088
<!-- La última versión puede consultarse en el repositorio de Maven -->
10861089
<version>3.10.0</version>
1090+
<configuration>
1091+
<source>23</source> <!-- Versión de Java. En mi caso, OpenJDK 23 -->
1092+
<show>private</show> <!-- Muestra los atributos privados -->
1093+
</configuracion>
10871094
</plugin>
10881095
</plugins>
10891096
</build>
@@ -1096,6 +1103,13 @@ este modo:
10961103
10971104
Se almacenará dentro de :file:`target/`.
10981105

1106+
.. caution:: Si comprueba que la documentación no refleja algún cambio que se
1107+
haya hecho en los comentarios, puede ejecutar a mano:
1108+
1109+
.. code-block:: console
1110+
1111+
$ mvn clean
1112+
10991113
.. seealso:: Para más información, consulte `las explicaciones de Maven al
11001114
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
11011115

docs/objects.inv

13 Bytes
Binary file not shown.

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

source/98.apendices/99.tools/10-vscode.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -916,6 +916,8 @@ mientras que en *Windows* podemos utilizar los instalables que nos ofrece
916916
Además, :ref:`Code Runner <code-runner>` no atenderá a la jerarquía de directorios creados por
917917
`Project Manager for Java`_.
918918

919+
.. _vscode-java-settings:
920+
919921
Además de estas extensiones puede interesarnos añadir configuración adicional:
920922

921923
.. code-block:: json
@@ -1069,7 +1071,8 @@ este modo:
10691071
}
10701072
10711073
.. note:: Y, posiblemente, también nos interese modificar el valor de
1072-
`files.exclude` para incluir :file:`target/`
1074+
`files.exclude` en :ref:`settings.json <vscode-java-settings>` para
1075+
incluir :file:`target/`
10731076

10741077
Además, es probable que queramos en algún momento generar documentación del
10751078
proyecto con Javadoc_ para ello debemos añadir al archivo :file:`pom.xml` el
@@ -1084,6 +1087,10 @@ este modo:
10841087
<artifactId>maven-javadoc-plugin</artifactId>
10851088
<!-- La última versión puede consultarse en el repositorio de Maven -->
10861089
<version>3.10.0</version>
1090+
<configuration>
1091+
<source>23</source> <!-- Versión de Java. En mi caso, OpenJDK 23 -->
1092+
<show>private</show> <!-- Muestra los atributos privados -->
1093+
</configuracion>
10871094
</plugin>
10881095
</plugins>
10891096
</build>
@@ -1096,6 +1103,13 @@ este modo:
10961103
10971104
Se almacenará dentro de :file:`target/`.
10981105

1106+
.. caution:: Si comprueba que la documentación no refleja algún cambio que se
1107+
haya hecho en los comentarios, puede ejecutar a mano:
1108+
1109+
.. code-block:: console
1110+
1111+
$ mvn clean
1112+
10991113
.. seealso:: Para más información, consulte `las explicaciones de Maven al
11001114
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
11011115

0 commit comments

Comments
 (0)