Skip to content

Commit 04656a4

Browse files
sio2sio2sio2sio2
committed
Añade algunas correcciones a Javadoc con Maven
1 parent 12115ca commit 04656a4

File tree

4 files changed

+50
-50
lines changed

4 files changed

+50
-50
lines changed

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

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1020,32 +1020,38 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10201020
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>+- src
10211021
| +-- main
10221022
| | +-- java
1023-
| | +-- es
1024-
| | +-- iescastillodeluna
1025-
| | +-- Main.java
1026-
| | +-- ... archivos del proyecto
1023+
| | +-- edu
1024+
| | +-- accesodatos +-- myapp
1025+
| | +-- Main.java
1026+
| | +-- ... archivos del proyecto
10271027
| +-- test (pruebas de software)
10281028
|
10291029
+- target (aquí dentro se guardan los .class)
10301030
+- pom.xml (configuración de Maven)
10311031
</pre></div>
10321032
</div>
1033+
<p>Se nos generará un archivo <code class="file docutils literal notranslate"><span class="pre">pom.xml</span></code> que podemos revisar para definir
1034+
la versión y el nombre del programa adecuados:</p>
1035+
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;version&gt;</span>1.0<span class="nt">&lt;/version&gt;</span>
1036+
<span class="nt">&lt;name&gt;</span>MiPrimeraAplicacion<span class="nt">&lt;/name&gt;</span>
1037+
</pre></div>
1038+
</div>
10331039
<p>La gestión del proyecto no es muy distinta de la ya descrita, aunque
10341040
deberemos cambiar el valor de la <em>mainClass</em> del <code class="file docutils literal notranslate"><span class="pre">launch.json</span></code>:</p>
10351041
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
1036-
<span class="w"> </span><span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0.0&quot;</span><span class="p">,</span>
1042+
<span class="w"> </span><span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;0.2.0&quot;</span><span class="p">,</span>
10371043
<span class="w"> </span><span class="nt">&quot;configurations&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
10381044
<span class="w"> </span><span class="p">{</span>
10391045
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;java&quot;</span><span class="p">,</span>
10401046
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Main&quot;</span><span class="p">,</span>
10411047
<span class="w"> </span><span class="nt">&quot;request&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;launch&quot;</span><span class="p">,</span>
1042-
<span class="hll"><span class="w"> </span><span class="nt">&quot;mainClass&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;es.iescastillodeluna.Main&quot;</span>
1048+
<span class="hll"><span class="w"> </span><span class="nt">&quot;mainClass&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;edu.accesodatos.myapp.Main&quot;</span>
10431049
</span><span class="w"> </span><span class="p">},</span>
10441050
<span class="w"> </span><span class="p">{</span>
10451051
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;java&quot;</span><span class="p">,</span>
10461052
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Main (assert)&quot;</span><span class="p">,</span>
10471053
<span class="w"> </span><span class="nt">&quot;request&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;launch&quot;</span><span class="p">,</span>
1048-
<span class="hll"><span class="w"> </span><span class="nt">&quot;mainClass&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;es.iescastillodeluna.Main&quot;</span><span class="p">,</span>
1054+
<span class="hll"><span class="w"> </span><span class="nt">&quot;mainClass&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;edu.accesodatos.myapp.Main&quot;</span><span class="p">,</span>
10491055
</span><span class="w"> </span><span class="nt">&quot;vmArgs&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;-ea&quot;</span>
10501056
<span class="w"> </span><span class="p">}</span>
10511057
<span class="w"> </span><span class="p">]</span>
@@ -1071,25 +1077,17 @@ <h2>Perfiles de desarrollo<a class="headerlink" href="#perfiles-de-desarrollo" t
10711077
<span class="w"> </span><span class="nt">&lt;configuration&gt;</span>
10721078
<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>
10731079
<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>
1080+
<span class="w"> </span><span class="nt">&lt;/configuration&gt;</span>
10751081
<span class="w"> </span><span class="nt">&lt;/plugin&gt;</span>
10761082
<span class="w"> </span><span class="nt">&lt;/plugins&gt;</span>
10771083
<span class="nt">&lt;/build&gt;</span>
10781084
</pre></div>
10791085
</div>
10801086
<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>
1081-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>javadoc:javadoc
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
10821088
</pre></div>
10831089
</div>
10841090
<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>
10931091
<div class="admonition seealso">
10941092
<p class="admonition-title">Ver también</p>
10951093
<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: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,35 +1036,43 @@ este modo:
10361036
+- src
10371037
| +-- main
10381038
| | +-- java
1039-
| | +-- es
1040-
| | +-- iescastillodeluna
1041-
| | +-- Main.java
1042-
| | +-- ... archivos del proyecto
1039+
| | +-- edu
1040+
| | +-- accesodatos +-- myapp
1041+
| | +-- Main.java
1042+
| | +-- ... archivos del proyecto
10431043
| +-- test (pruebas de software)
10441044
|
10451045
+- target (aquí dentro se guardan los .class)
10461046
+- pom.xml (configuración de Maven)
10471047
1048+
Se nos generará un archivo :file:`pom.xml` que podemos revisar para definir
1049+
la versión y el nombre del programa adecuados:
1050+
1051+
.. code-block:: xml
1052+
1053+
<version>1.0</version>
1054+
<name>MiPrimeraAplicacion</name>
1055+
10481056
La gestión del proyecto no es muy distinta de la ya descrita, aunque
10491057
deberemos cambiar el valor de la *mainClass* del :file:`launch.json`:
10501058

10511059
.. code-block:: json
10521060
:emphasize-lines: 8, 14
10531061
10541062
{
1055-
"version": "2.0.0",
1063+
"version": "0.2.0",
10561064
"configurations": [
10571065
{
10581066
"type": "java",
10591067
"name": "Main",
10601068
"request": "launch",
1061-
"mainClass": "es.iescastillodeluna.Main"
1069+
"mainClass": "edu.accesodatos.myapp.Main"
10621070
},
10631071
{
10641072
"type": "java",
10651073
"name": "Main (assert)",
10661074
"request": "launch",
1067-
"mainClass": "es.iescastillodeluna.Main",
1075+
"mainClass": "edu.accesodatos.myapp.Main",
10681076
"vmArgs": "-ea"
10691077
}
10701078
]
@@ -1090,7 +1098,7 @@ este modo:
10901098
<configuration>
10911099
<source>23</source> <!-- Versión de Java. En mi caso, OpenJDK 23 -->
10921100
<show>private</show> <!-- Muestra los atributos privados -->
1093-
</configuracion>
1101+
</configuration>
10941102
</plugin>
10951103
</plugins>
10961104
</build>
@@ -1099,17 +1107,10 @@ este modo:
10991107

11001108
.. code-block:: console
11011109
1102-
$ mvn javadoc:javadoc
1110+
$ mvn clean javadoc:javadoc
11031111
11041112
Se almacenará dentro de :file:`target/`.
11051113

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-
11131114
.. seealso:: Para más información, consulte `las explicaciones de Maven al
11141115
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
11151116

‎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: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,35 +1036,43 @@ este modo:
10361036
+- src
10371037
| +-- main
10381038
| | +-- java
1039-
| | +-- es
1040-
| | +-- iescastillodeluna
1041-
| | +-- Main.java
1042-
| | +-- ... archivos del proyecto
1039+
| | +-- edu
1040+
| | +-- accesodatos +-- myapp
1041+
| | +-- Main.java
1042+
| | +-- ... archivos del proyecto
10431043
| +-- test (pruebas de software)
10441044
|
10451045
+- target (aquí dentro se guardan los .class)
10461046
+- pom.xml (configuración de Maven)
10471047
1048+
Se nos generará un archivo :file:`pom.xml` que podemos revisar para definir
1049+
la versión y el nombre del programa adecuados:
1050+
1051+
.. code-block:: xml
1052+
1053+
<version>1.0</version>
1054+
<name>MiPrimeraAplicacion</name>
1055+
10481056
La gestión del proyecto no es muy distinta de la ya descrita, aunque
10491057
deberemos cambiar el valor de la *mainClass* del :file:`launch.json`:
10501058

10511059
.. code-block:: json
10521060
:emphasize-lines: 8, 14
10531061
10541062
{
1055-
"version": "2.0.0",
1063+
"version": "0.2.0",
10561064
"configurations": [
10571065
{
10581066
"type": "java",
10591067
"name": "Main",
10601068
"request": "launch",
1061-
"mainClass": "es.iescastillodeluna.Main"
1069+
"mainClass": "edu.accesodatos.myapp.Main"
10621070
},
10631071
{
10641072
"type": "java",
10651073
"name": "Main (assert)",
10661074
"request": "launch",
1067-
"mainClass": "es.iescastillodeluna.Main",
1075+
"mainClass": "edu.accesodatos.myapp.Main",
10681076
"vmArgs": "-ea"
10691077
}
10701078
]
@@ -1090,7 +1098,7 @@ este modo:
10901098
<configuration>
10911099
<source>23</source> <!-- Versión de Java. En mi caso, OpenJDK 23 -->
10921100
<show>private</show> <!-- Muestra los atributos privados -->
1093-
</configuracion>
1101+
</configuration>
10941102
</plugin>
10951103
</plugins>
10961104
</build>
@@ -1099,17 +1107,10 @@ este modo:
10991107

11001108
.. code-block:: console
11011109
1102-
$ mvn javadoc:javadoc
1110+
$ mvn clean javadoc:javadoc
11031111
11041112
Se almacenará dentro de :file:`target/`.
11051113

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-
11131114
.. seealso:: Para más información, consulte `las explicaciones de Maven al
11141115
respecto <https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html>`_.
11151116

0 commit comments

Comments
 (0)