Updated Documentation

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,36 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="JavaDoc" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="TOP_LEVEL_CLASS_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
+          <option name="REQUIRED_TAGS" value="" />
+        </value>
+      </option>
+      <option name="INNER_CLASS_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
+          <option name="REQUIRED_TAGS" value="" />
+        </value>
+      </option>
+      <option name="METHOD_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
+          <option name="REQUIRED_TAGS" value="@return@param@throws or @exception" />
+        </value>
+      </option>
+      <option name="FIELD_OPTIONS">
+        <value>
+          <option name="ACCESS_JAVADOC_REQUIRED_FOR" value="none" />
+          <option name="REQUIRED_TAGS" value="" />
+        </value>
+      </option>
+      <option name="IGNORE_DEPRECATED" value="false" />
+      <option name="IGNORE_JAVADOC_PERIOD" value="true" />
+      <option name="IGNORE_DUPLICATED_THROWS" value="false" />
+      <option name="IGNORE_POINT_TO_ITSELF" value="false" />
+      <option name="myAdditionalJavadocTags" value="code&quot;&lt;link&gt;&lt;/link&gt;&quot;" />
+    </inspection_tool>
+  </profile>
+</component>

docs.org

@@ -17,6 +17,10 @@ fordítása a következő parancsal fordíthatja le:
 mvn clean package
 #+END_SRC
 
+** Usecase-ek
+*Hírcsatornák  kezelése:* A felhasználónak lesz lehetősőge új csatornákatfelvenni, a meglévőket törölni vagy átcsoportosítani.
+*Hírek  böngészése:* A letöltött hírekk között a felhasználó kedvére bön-gészhet
+*Cikk olvasása:* Egy cikk címére kattintva a felhasználó elolvashatja a kivá-lasztott cikket.
 ** Osztályok leírása
 Az osztályok leírását a JavaDoc dokumentációban olvasható el.
 ** OsztályDiagram

src/main/java/eu/toldi/rss/FeedData.java

@@ -261,8 +261,14 @@ public class FeedData extends AbstractTableModel {
 
     /**
      * A hírcsatornák listájának kimentése egy XML fájlba.
-     *
+     * A fájl legefelső tagja "list" típusú. Ennek az ágai egy-egy feed vagy feedGroup.
+     * A feed típus egy ágában szerepelni kell a hírcsatorna linkjét ({@code<link>}). Ezen kívül tartalmazhatja a nevét,
+     * valamint a hozzá tartozó cikkek listáját ({@code<articleList>})
+     * A feedGroup tipusú ágakban a csoport nevének kell szerepelnie,valamint a hozzá tartozó hírcsatornák listája ({@code<feedList>}).
+     * Az utóbbin belüli ágak formátuma megegyeznek a korábban leírtakkal ({@code<feed>}).
      * @param filename A fájl ahová menteni szeretné az adatokat
+     * Kimentett fájl leírása:
+     *
      */
     public synchronized void save(String filename) {
         XStream xStream = initXstream();