Skip to content

Commit bffd3e0

Browse files
committed
Modifica las explicaciones sobre cómo ejecutar javadoc en VSCode
1 parent 04656a4 commit bffd3e0

File tree

8 files changed

+151
-25
lines changed

8 files changed

+151
-25
lines changed

docs/01.intro/02a.serial.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ <h1><span class="section-number">1.2.1. </span>Lenguajes de serialización de da
116116
pero es obligatorio que lo estén si contienen uno de los tres caracteres que
117117
distorsiona la lectura: el delimitador, el cambio de línea o la propia
118118
comilla doble<a class="footnote-reference brackets" href="#id16" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a>.</p></li>
119-
<li><p>En un campo entrecomillado, si el texto contiene un carácter de comilla doble
120-
este debe representarse con dos caracteres seguidos de comilla doble.</p></li>
119+
<li><p>En un campo entrecomillado, si el texto contiene un carácter de comilla
120+
doble, éste debe representarse con dos caracteres seguidos de comilla doble.</p></li>
121121
</ol>
122122
<p>Ejemplo:</p>
123123
<div class="highlight-csv notranslate"><div class="highlight"><pre><span></span>Campo 1,Campo 2,Campo 3,Campo 4

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

Lines changed: 48 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -939,15 +939,17 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
939939
Podemos, por supuesto, abrir una terminal (<kbd class="kbd docutils literal notranslate">Ctrl</kbd>+<kbd class="kbd docutils literal notranslate">`</kbd>) y escribir
940940
directamente la orden en ella, pero sin duda es más cómodo <a class="reference internal" href="#vscode-tasks"><span class="std std-ref">crear una tarea</span></a> y asociarla a una <a class="reference internal" href="#vscode-atajos"><span class="std std-ref">combinación de teclas</span></a>.
941941
La tarea podemos definirla con este código <abbr title="JavaScript Object Notation">JSON</abbr>:</p>
942-
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
942+
<div class="highlight-json notranslate" id="vscode-definir-jshell"><div class="highlight"><pre><span></span><span class="p">{</span>
943943
<span class="w"> </span><span class="nt">&quot;label&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Shell para Java&quot;</span><span class="p">,</span>
944944
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;shell&quot;</span><span class="p">,</span>
945945
<span class="w"> </span><span class="nt">&quot;command&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;jshell&quot;</span><span class="p">,</span>
946946
<span class="w"> </span><span class="nt">&quot;windows&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
947947
<span class="w"> </span><span class="c1">// Adoption al instalar Java no define la variable JAVA_HOME,</span>
948-
<span class="w"> </span><span class="c1">// sino quue añade la localización del programa al PATH.</span>
948+
<span class="w"> </span><span class="c1">// sino quue añade la localización del programa al PATH. De lo</span>
949+
<span class="w"> </span><span class="c1">// contrario habría que hacer algo así:</span>
949950
<span class="w"> </span><span class="c1">// &quot;command&quot;: &quot;${env:JAVA_HOME}\\bin\\jshell.exe&quot;</span>
950951
<span class="w"> </span><span class="p">},</span>
952+
<span class="w"> </span><span class="nt">&quot;args&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w"> </span><span class="c1">// Sin argumentos.</span>
951953
<span class="w"> </span><span class="nt">&quot;presentation&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
952954
<span class="w"> </span><span class="nt">&quot;reveal&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;always&quot;</span><span class="p">,</span>
953955
<span class="w"> </span><span class="nt">&quot;panel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;new&quot;</span>
@@ -1064,6 +1066,11 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10641066
<cite>files.exclude</cite> en <a class="reference internal" href="#vscode-java-settings"><span class="std std-ref">settings.json</span></a> para
10651067
incluir <code class="file docutils literal notranslate"><span class="pre">target/</span></code></p>
10661068
</div>
1069+
<div class="admonition seealso">
1070+
<p class="admonition-title">Ver también</p>
1071+
<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
1072+
respecto</a>.</p>
1073+
</div>
10671074
<p>Además, es probable que queramos en algún momento generar documentación del
10681075
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
10691076
siguiente bloque:</p>
@@ -1084,14 +1091,47 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10841091
</pre></div>
10851092
</div>
10861093
<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>
1087-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>clean<span class="w"> </span>javadoc:javadoc
1094+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>javadoc:javadoc
10881095
</pre></div>
10891096
</div>
1090-
<p>Se almacenará dentro de <code class="file docutils literal notranslate"><span class="pre">target/</span></code>.</p>
1091-
<div class="admonition seealso">
1092-
<p class="admonition-title">Ver también</p>
1093-
<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
1094-
respecto</a>.</p>
1097+
<p>Se almacenará dentro de <code class="file docutils literal notranslate"><span class="pre">target/reports/apidocs</span></code>. Ahora bien, en
1098+
ocasiones, al regenerar la documentación, puede ocurrir que no se refleje un
1099+
cambio por culpa de los archivos ya generados. En estos casos, lo mejor es
1100+
eliminarlos antes de volver a generar la documentación. Para ello lo más cómo
1101+
es añadir algo más al archivo <code class="file docutils literal notranslate"><span class="pre">pom.xml</span></code>:</p>
1102+
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;profiles&gt;</span>
1103+
<span class="w"> </span><span class="nt">&lt;profile&gt;</span>
1104+
<span class="w"> </span><span class="nt">&lt;id&gt;</span>clean-javadoc-only<span class="nt">&lt;/id&gt;</span>
1105+
<span class="w"> </span><span class="nt">&lt;build&gt;</span>
1106+
<span class="w"> </span><span class="nt">&lt;plugins&gt;</span>
1107+
<span class="w"> </span><span class="nt">&lt;plugin&gt;</span>
1108+
<span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>maven-clean-plugin<span class="nt">&lt;/artifactId&gt;</span>
1109+
<span class="w"> </span><span class="nt">&lt;configuration&gt;</span>
1110+
<span class="w"> </span><span class="nt">&lt;excludeDefaultDirectories&gt;</span>true<span class="nt">&lt;/excludeDefaultDirectories&gt;</span>
1111+
<span class="w"> </span><span class="nt">&lt;filesets&gt;</span>
1112+
<span class="w"> </span><span class="nt">&lt;fileset&gt;</span>
1113+
<span class="w"> </span><span class="nt">&lt;directory&gt;</span>${project.build.directory}/reports/apidocs<span class="nt">&lt;/directory&gt;</span>
1114+
<span class="w"> </span><span class="nt">&lt;/fileset&gt;</span>
1115+
<span class="w"> </span><span class="nt">&lt;/filesets&gt;</span>
1116+
<span class="w"> </span><span class="nt">&lt;/configuration&gt;</span>
1117+
<span class="w"> </span><span class="nt">&lt;/plugin&gt;</span>
1118+
<span class="w"> </span><span class="nt">&lt;/plugins&gt;</span>
1119+
<span class="w"> </span><span class="nt">&lt;/build&gt;</span>
1120+
<span class="w"> </span><span class="nt">&lt;/profile&gt;</span>
1121+
<span class="nt">&lt;/profiles&gt;</span>
1122+
</pre></div>
1123+
</div>
1124+
<p>que crea un perfil (<em>clean-javadoc-only</em>) que ejecuta el plugin de limpiado
1125+
de <em>Maven</em>, no limpiando todos los archivos, sino sólo los relativos a
1126+
<em>Javadoc</em>. Con ello podremos generar la documentación así:</p>
1127+
<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
1128+
</pre></div>
1129+
</div>
1130+
<div class="admonition tip">
1131+
<p class="admonition-title">Truco</p>
1132+
<p>Si <a class="reference internal" href="#vscode-tasks"><span class="std std-ref">creamos una tarea</span></a> y le asociamos una
1133+
<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
1134+
jshell</span></a>. todo será muy cómodo.</p>
10951135
</div>
10961136
</dd>
10971137
<dt><strong>Exportar JAR</strong></dt><dd><p>Una acción muy recorrente, una vez que tengamos acabado un proyecto, es crear

docs/_sources/01.intro/02a.serial.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ siguientes:
4040
pero es obligatorio que lo estén si contienen uno de los tres caracteres que
4141
distorsiona la lectura: el delimitador, el cambio de línea o la propia
4242
comilla doble\ [#]_.
43-
#. En un campo entrecomillado, si el texto contiene un carácter de comilla doble
44-
este debe representarse con dos caracteres seguidos de comilla doble.
43+
#. En un campo entrecomillado, si el texto contiene un carácter de comilla
44+
doble, éste debe representarse con dos caracteres seguidos de comilla doble.
4545

4646
Ejemplo:
4747

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

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -939,6 +939,8 @@ directamente la orden en ella, pero sin duda es más cómodo :ref:`crear una tar
939939
<vscode-tasks>` y asociarla a una :ref:`combinación de teclas <vscode-atajos>`.
940940
La tarea podemos definirla con este código |JSON|:
941941

942+
.. _vscode-definir-jshell:
943+
942944
.. code:: json
943945
944946
{
@@ -947,9 +949,11 @@ La tarea podemos definirla con este código |JSON|:
947949
"command": "jshell",
948950
"windows": {
949951
// Adoption al instalar Java no define la variable JAVA_HOME,
950-
// sino quue añade la localización del programa al PATH.
952+
// sino quue añade la localización del programa al PATH. De lo
953+
// contrario habría que hacer algo así:
951954
// "command": "${env:JAVA_HOME}\\bin\\jshell.exe"
952955
},
956+
"args": [], // Sin argumentos.
953957
"presentation": {
954958
"reveal": "always",
955959
"panel": "new"
@@ -1082,6 +1086,9 @@ este modo:
10821086
`files.exclude` en :ref:`settings.json <vscode-java-settings>` para
10831087
incluir :file:`target/`
10841088

1089+
.. seealso:: Para más información, consulte `las explicaciones de Maven al
1090+
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
1091+
10851092
Además, es probable que queramos en algún momento generar documentación del
10861093
proyecto con Javadoc_ para ello debemos añadir al archivo :file:`pom.xml` el
10871094
siguiente bloque:
@@ -1107,12 +1114,48 @@ este modo:
11071114

11081115
.. code-block:: console
11091116
1110-
$ mvn clean javadoc:javadoc
1117+
$ mvn javadoc:javadoc
11111118
1112-
Se almacenará dentro de :file:`target/`.
1119+
Se almacenará dentro de :file:`target/reports/apidocs`. Ahora bien, en
1120+
ocasiones, al regenerar la documentación, puede ocurrir que no se refleje un
1121+
cambio por culpa de los archivos ya generados. En estos casos, lo mejor es
1122+
eliminarlos antes de volver a generar la documentación. Para ello lo más cómo
1123+
es añadir algo más al archivo :file:`pom.xml`:
11131124

1114-
.. seealso:: Para más información, consulte `las explicaciones de Maven al
1115-
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
1125+
.. code-block:: xml
1126+
1127+
<profiles>
1128+
<profile>
1129+
<id>clean-javadoc-only</id>
1130+
<build>
1131+
<plugins>
1132+
<plugin>
1133+
<artifactId>maven-clean-plugin</artifactId>
1134+
<configuration>
1135+
<excludeDefaultDirectories>true</excludeDefaultDirectories>
1136+
<filesets>
1137+
<fileset>
1138+
<directory>${project.build.directory}/reports/apidocs</directory>
1139+
</fileset>
1140+
</filesets>
1141+
</configuration>
1142+
</plugin>
1143+
</plugins>
1144+
</build>
1145+
</profile>
1146+
</profiles>
1147+
1148+
que crea un perfil (*clean-javadoc-only*) que ejecuta el plugin de limpiado
1149+
de *Maven*, no limpiando todos los archivos, sino sólo los relativos a
1150+
*Javadoc*. Con ello podremos generar la documentación así:
1151+
1152+
.. code-block:: console
1153+
1154+
$ mvn clean:clean javadoc:javadoc -Pclean-javadoc-only
1155+
1156+
.. tip:: Si :ref:`creamos una tarea <vscode-tasks>` y le asociamos una
1157+
:ref:`combinación de teclas <vscode-atajos>`, tal :ref:`como hicimos con
1158+
jshell <vscode-definir-jshell>`. todo será muy cómodo.
11161159

11171160
**Exportar JAR**
11181161
Una acción muy recorrente, una vez que tengamos acabado un proyecto, es crear

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/01.intro/02a.serial.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ siguientes:
4040
pero es obligatorio que lo estén si contienen uno de los tres caracteres que
4141
distorsiona la lectura: el delimitador, el cambio de línea o la propia
4242
comilla doble\ [#]_.
43-
#. En un campo entrecomillado, si el texto contiene un carácter de comilla doble
44-
este debe representarse con dos caracteres seguidos de comilla doble.
43+
#. En un campo entrecomillado, si el texto contiene un carácter de comilla
44+
doble, éste debe representarse con dos caracteres seguidos de comilla doble.
4545

4646
Ejemplo:
4747

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

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -939,6 +939,8 @@ directamente la orden en ella, pero sin duda es más cómodo :ref:`crear una tar
939939
<vscode-tasks>` y asociarla a una :ref:`combinación de teclas <vscode-atajos>`.
940940
La tarea podemos definirla con este código |JSON|:
941941

942+
.. _vscode-definir-jshell:
943+
942944
.. code:: json
943945
944946
{
@@ -947,9 +949,11 @@ La tarea podemos definirla con este código |JSON|:
947949
"command": "jshell",
948950
"windows": {
949951
// Adoption al instalar Java no define la variable JAVA_HOME,
950-
// sino quue añade la localización del programa al PATH.
952+
// sino quue añade la localización del programa al PATH. De lo
953+
// contrario habría que hacer algo así:
951954
// "command": "${env:JAVA_HOME}\\bin\\jshell.exe"
952955
},
956+
"args": [], // Sin argumentos.
953957
"presentation": {
954958
"reveal": "always",
955959
"panel": "new"
@@ -1082,6 +1086,9 @@ este modo:
10821086
`files.exclude` en :ref:`settings.json <vscode-java-settings>` para
10831087
incluir :file:`target/`
10841088

1089+
.. seealso:: Para más información, consulte `las explicaciones de Maven al
1090+
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
1091+
10851092
Además, es probable que queramos en algún momento generar documentación del
10861093
proyecto con Javadoc_ para ello debemos añadir al archivo :file:`pom.xml` el
10871094
siguiente bloque:
@@ -1107,12 +1114,48 @@ este modo:
11071114

11081115
.. code-block:: console
11091116
1110-
$ mvn clean javadoc:javadoc
1117+
$ mvn javadoc:javadoc
11111118
1112-
Se almacenará dentro de :file:`target/`.
1119+
Se almacenará dentro de :file:`target/reports/apidocs`. Ahora bien, en
1120+
ocasiones, al regenerar la documentación, puede ocurrir que no se refleje un
1121+
cambio por culpa de los archivos ya generados. En estos casos, lo mejor es
1122+
eliminarlos antes de volver a generar la documentación. Para ello lo más cómo
1123+
es añadir algo más al archivo :file:`pom.xml`:
11131124

1114-
.. seealso:: Para más información, consulte `las explicaciones de Maven al
1115-
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
1125+
.. code-block:: xml
1126+
1127+
<profiles>
1128+
<profile>
1129+
<id>clean-javadoc-only</id>
1130+
<build>
1131+
<plugins>
1132+
<plugin>
1133+
<artifactId>maven-clean-plugin</artifactId>
1134+
<configuration>
1135+
<excludeDefaultDirectories>true</excludeDefaultDirectories>
1136+
<filesets>
1137+
<fileset>
1138+
<directory>${project.build.directory}/reports/apidocs</directory>
1139+
</fileset>
1140+
</filesets>
1141+
</configuration>
1142+
</plugin>
1143+
</plugins>
1144+
</build>
1145+
</profile>
1146+
</profiles>
1147+
1148+
que crea un perfil (*clean-javadoc-only*) que ejecuta el plugin de limpiado
1149+
de *Maven*, no limpiando todos los archivos, sino sólo los relativos a
1150+
*Javadoc*. Con ello podremos generar la documentación así:
1151+
1152+
.. code-block:: console
1153+
1154+
$ mvn clean:clean javadoc:javadoc -Pclean-javadoc-only
1155+
1156+
.. tip:: Si :ref:`creamos una tarea <vscode-tasks>` y le asociamos una
1157+
:ref:`combinación de teclas <vscode-atajos>`, tal :ref:`como hicimos con
1158+
jshell <vscode-definir-jshell>`. todo será muy cómodo.
11161159

11171160
**Exportar JAR**
11181161
Una acción muy recorrente, una vez que tengamos acabado un proyecto, es crear

0 commit comments

Comments
 (0)