Guten Abend,
ich habe nach bestem Wissen und Gewissen einen Heap implementiert und wollte dann noch mehr oder weniger sinnvolle javadoc Kommentare ergänzen. Hierbei treten aber ein paar Probleme auf (mal ganz abgesehen von den Umlauten). Einen Stück meines Codes hänge ich an, konkret geht es um die folgenden Punkte:
1) Die Klassenbeschreibung wird nicht angezeigt, also "Dieser Text taucht nicht auf".
2) Die compare Methode erscheint ebenfalls nicht.
3) Ich Erhalte diese Warnung: "Heap.java:43: warning - @param argument "item:" is not a parameter name." Dabei heißt der Parameter doch item?
Mit freundlichem Gruß
Raveulo
Edit: Ich rufe javadoc übrigens einfach über die Konsole mit javadoc *.java auf
ich habe nach bestem Wissen und Gewissen einen Heap implementiert und wollte dann noch mehr oder weniger sinnvolle javadoc Kommentare ergänzen. Hierbei treten aber ein paar Probleme auf (mal ganz abgesehen von den Umlauten). Einen Stück meines Codes hänge ich an, konkret geht es um die folgenden Punkte:
1) Die Klassenbeschreibung wird nicht angezeigt, also "Dieser Text taucht nicht auf".
2) Die compare Methode erscheint ebenfalls nicht.
3) Ich Erhalte diese Warnung: "Heap.java:43: warning - @param argument "item:" is not a parameter name." Dabei heißt der Parameter doch item?
Mit freundlichem Gruß
Raveulo
Edit: Ich rufe javadoc übrigens einfach über die Konsole mit javadoc *.java auf
Java:
/**
* Dieser Text taucht nicht auf
*
* @author ich
* @version 1.0
*/
import java.util.ArrayList;
import java.util.NoSuchElementException;
public abstract class Heap<T> {
ArrayList<T> items = new ArrayList<T>();
/**
* Initalisiert die verwendete ArrayList zum Speichern der Objekte
*/
public Heap(){
items = new ArrayList<T>();
}
/**
* Abstrakte Methode zum Vergleich zweier Objekte des verwendeten Datentypes.
* Für einen MinimumHeap muss die Rückgabe invertiert werden
* @param x erste Element
* @param y zweite Element
* @return true wenn x > y, sonst false
*/
abstract boolean compare(T x, T y);
/**
* Gibt die Größe des Heaps zurück
* @return Anzahl der Elemente im Heap
*/
public int size(){
return items.size();
}
/**
* Einfügen eines neuen Elementes in den Heap
@param item: das einzufuegende Element
*/
public void insert(T item){
items.add(item);
siftUp();
}
/**
* Entfernen des obersten Elementes des Heaps
* @return ehemals oberste Element des Heaps
*/
public T delete() throws NoSuchElementException{
if(items.size() == 0){
throw new NoSuchElementException();
}
if(items.size() == 1){
return items.remove(0);
}
T hold = items.get(0);
items.set(0, items.remove(items.size()-1));
siftDown();
return hold;
}
}
Zuletzt bearbeitet: