Skip to content

Technik Blog

Programmieren | Arduino | ESP32 | MicroPython | Python | Raspberry PI

Menu
  • Projekte
    • LED’s
    • Servo & Schrittmotoren
    • Sound
    • Displays (LCD, OLED, LED)
    • Kommunikation
    • Sicherheit
    • Smarthome
    • Weekend Project
  • Mikrocontroller
    • Arduino
      • Tutorials
      • ProMini
        • Anschließen & Programmieren
      • Nano
        • Arduino Nano – Übersicht
      • UNO
        • Übersicht
        • Funduino UNO
        • Maker UNO – Überblick und Test
        • Arduino UNO R4 WiFi / Minima
      • MEGA 2560
        • Funduino Mega 2560 R3
        • Übersicht
      • Leonardo
        • Übersicht
    • ESP32
      • ESP32-CAM
        • Einrichten der ESP32-CAM und erster betrieb
        • ESP32 CAM als Access Point einrichten
        • DIY ESP32 CAM FTDI Adapter
        • ESP32 CAM – Vergleich der verfügbaren Kameralinsen
        • Python – ESP32 CAM Bild speichern
        • ESP32-CAM – Bewegung ermitteln mit Python3
        • ESP32-CAM WROVER E
        • ESP32-CAM Stream per Python3 aufzeichnen
      • Infrarot-Fernbedienung mit dem ESP32 und MicroPython auslesen: Ein Anfängerleitfaden
      • Der ESP32 Plus von Keyestudio: Ein leistungsstarker Mikrocontroller im Arduino-UNO-Format
      • Mikrocontroller ESP32 H2 im Test
      • Seeed Studio ESP32C3 & Bluetooth
    • ESP8266
      • NodeMCU – “Einer für (fast) Alles!”
      • WEMOS
        • WEMOS D1 – Arduino UNO kompatibles Board mit ESP8266 Chip
        • WEMOS D1 Mini – Übersicht
        • Wemos D1 mini Shields
    • Raspberry Pi Pico
      • Raspberry Pi Pico RESET-Taster: So fügst du ihn hinzu
      • Ein erster Blick auf den Melopero Cookie RP2040: Raspberry Pi Pico meets micro:bit
      • Raspberry Pi Pico Pinout: Eine ausführliche Übersicht
      • Vergleich Raspberry Pi Pico & RP2040:bit
      • Raspberry Pi Pico: Programmierung und Entwicklung mit der Arduino IDE auf Linux
  • Newsletter
  • Über mich
  • DeutschDeutsch
  • EnglishEnglish
Menu

Apache Maven: JavaDoc erstellen

Posted on 16. Oktober 20183. Mai 2023 by Stefan Draeger

Im Tutorial Apache Ant: JavaDoc erstellen habe ich erläutert wie man mit Apache Ant automatisch das JavaDoc erzeugen kann. Da aber Ant so etwas in die Jahre gekommen ist möchte ich nun vorstellen wie dieses mit Apache Maven gemacht wird.

Als Grundlage soll hier das gleiche Eclipse Projekt dienen (eine einfache Main Klasse mit einer inneren Klasse und etwas JavaDoc).

  • Plugin
    • Konfiguration
      • show
      • destDir
  • Ausführen
    • Erzeugen einer Eclipse Run Configuration
  • Download

Plugin

Für das Generieren des JavaDoc wird ein Plugin benötigt, welches in der Datei „pom.xml“ definiert wird.

<build>
   <plugins>
      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
	 <artifactId>maven-javadoc-plugin</artifactId>
	 <version>3.0.1</version>
	 <configuration>
	 </configuration>
      </plugin>
   </plugins>
</build>

Konfiguration

Das Attribut „configuration“ kann um folgende weitere Attribute erweitert werden:

show

In diesem Attribut wird definiert ab welcher Sichtbarkeit das JavaDoc Kommentar einfließen soll.
Mögliche Werte sind hier:

  • private
  • protected
  • public
<show>private</show>

destDir

Das Attribut „destDir“ definiert den Ablageort der JavaDoc. Das JavaDoc wird generell unter dem Pfad <<Projek>>\target\site\apidocs\“ abgelegt. Wenn man nun den Pfad speziell definiert, so wird unter dem allgemeinen Pfad ein neuer Ordner angelegt.

Wenn man jedoch nun in diesem Baum nach oben navigieren möchte, so kann man „../“ vor dem Verzeichnisnamen setzen, zbsp:

<destDir>../javaDoc</destDir>

Ausführen

Zum Ausführen des Maven Goals kann man entweder die Kommandozeile benutzen (vorher ggf. die Umgebungsvariablen anpassen) oder aber aus der Eclipse IDE.

Erzeugen einer Eclipse Run Configuration

Um eine Run Configuration zu erzeugen, navigiert man über das Kontextmenü des Projektes (rechte Maustaste“auf dem Namen des Projektes) > „Run As“  > „Run Configurations…“

Eclipse - öffnen von "Run Configurations"
Eclipse – öffnen von „Run Configurations“

Im nun neu geöffneten Fenster wählt man aus dem Baum mit einem Doppelklick aus.

Als Erstes wird ein Name vergeben (1) und danach das Projekt benannt (2) im dritten und letzten Schritt wird
das Goal (Maven „Task“) benannt, in diesem Fall geben wir „javadoc:javadoc“ ein.

Eclipse - erzeugen einer Konfiguration
Eclipse – erzeugen einer Konfiguration

Die Eingabe der Daten bestätigen wir mit der Schaltfläche „Apply“ und starten die Ausführung mit der Schaltfläche „Run“.

Es wird nun automatisch zum Tab „Console“ gewechselt und man sieht die Ausführung.

Maven ausführen vom Goal javadoc:javadoc
Maven ausführen vom Goal javadoc:javadoc

Download

Apache Maven – JavaDoc (Eclipse Projekt)Herunterladen

Eine ausführliche Dokumentation zum JavaDoc Plugin findest du unter https://maven.apache.org/plugins/maven-javadoc-plugin/index.html.

Schreibe einen Kommentar Antworten abbrechen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert


Unterstütze meinen Blog!


Liebe Leserinnen und Leser,

Unterstützt meinen Blog auf Tipeee und helft dabei, hochwertige Inhalte zu sichern! https://de.tipeee.com/draeger-itblog/.

Jeder Beitrag zählt. Vielen Dank für eure Unterstützung!

Stefan Draeger


Kategorien

Tools

  • 8×8 LED Matrix Tool
  • 8×16 LED Matrix Modul von Keyestudio
  • 16×16 LED Matrix – Generator
  • Widerstandsrechner
  • Rechner für Strom & Widerstände
  • ASCII Tabelle

Meta

  • Videothek
  • Impressum
  • Datenschutzerklärung
  • Disclaimer
  • Kontakt
  • Cookie-Richtlinie (EU)

Links

Blogverzeichnis Bloggerei.de Blogverzeichnis TopBlogs.de das Original - Blogverzeichnis | Blog Top Liste Blogverzeichnis trusted-blogs.com
©2023 Technik Blog | Built using WordPress and Responsive Blogily theme by Superb