Doku ergaenzt

ulrich@undisclosed

2020-04-22 d572ec8e5807f9431bfebcad8110972de2da53a7

Doku ergaenzt

 src/de/uhilger/wbx/web/AdocServlet.java

@@ -40,7 +40,7 @@
 * Das AdocServlet wandelt AsciiDoc-Inhalte (*.adoc) 
 * zu HTML-Seiten und PDF-Dokumenten
 * 
 * ?pdf=true im URL fuegt PDF-Ausgabe hinzu
 * Mit Angabe des Parameters ?pdf=true im URL wird PDF erzeugt, andernfalls HTML
 */
public class AdocServlet extends HttpServlet  {
  
@@ -50,13 +50,13 @@
  private static final String SERVLET_NAME = "AdocServlet";
  
  /**
   * Processes requests for both HTTP <code>GET</code> and <code>POST</code>
   * methods.
   * Die Methode processRequest verarbeitet HTTP-Anfragen des Typs  
   * <code>GET</code> und <code>POST</code>.
   *
   * @param request servlet request
   * @param response servlet response
   * @throws ServletException if a servlet-specific error occurs
   * @throws IOException if an I/O error occurs
   * @param request die Servlet-Anfrage
   * @param response die Servlet-Antwort
   * @throws ServletException wenn ein Servlet-spezifischer Fehler passiert
   * @throws IOException wenn ein Eingabe- oder Ausgabe-Fehler passiert
   */
  protected void processRequest(HttpServletRequest request, HttpServletResponse response)
          throws ServletException, IOException 
@@ -108,10 +108,21 @@
    }
  }
  
  /**
   * Nach HTML transformieren
   * @param fileName der Dateiname der Quelldatei samt absoluter Pfadangabe
   */
  private void transform(String fileName) {
    transform(fileName, null);
  }  
  
  /**
   * In ein Format transformieren, das von einem 'Backend' von Asciidoctor 
   * unterstuetzt wird
   * @param fileName der Dateiname der Quelldatei samt absoluter Pfadangabe
   * @param backend das Kuerzel des Backends, z.B. der String 'pdf', wenn 
   * nach PDF transformiert werden soll
   */
  private void transform(String fileName, String backend) {    
    Map<String, Object> attributes = new HashMap<>();
    attributes.put("no_footer", false);
@@ -129,12 +140,12 @@
  }

  /**
   * Handles the HTTP <code>GET</code> method.
   * Die HTTP-<code>GET</code>-Methode verarbeiten.
   *
   * @param request servlet request
   * @param response servlet response
   * @throws ServletException if a servlet-specific error occurs
   * @throws IOException if an I/O error occurs
   * @param request die Servlet-Anfrage
   * @param response die Servlet-Antwort
   * @throws ServletException wenn ein Servlet-spezifischer Fehler passiert
   * @throws IOException wenn ein Eingabe- oder Ausgabe-Fehler passiert
   */
  @Override
  protected void doGet(HttpServletRequest request, HttpServletResponse response)
@@ -143,12 +154,12 @@
  }

  /**
   * Handles the HTTP <code>POST</code> method.
   * Die HTTP-<code>POST</code>-Methode verarbeiten.
   *
   * @param request servlet request
   * @param response servlet response
   * @throws ServletException if a servlet-specific error occurs
   * @throws IOException if an I/O error occurs
   * @param request die Servlet-Anfrage
   * @param response die Servlet-Antwort
   * @throws ServletException wenn ein Servlet-spezifischer Fehler passiert
   * @throws IOException wenn ein Eingabe- oder Ausgabe-Fehler passiert
   */
  @Override
  protected void doPost(HttpServletRequest request, HttpServletResponse response)
@@ -157,9 +168,9 @@
  }

  /**
   * Returns a short description of the servlet.
   * Eine Kurzbeschreibung des Servlets ausgeben.
   *
   * @return a String containing servlet description
   * @return einen String mit der Kurzbeschreibung des Servlets
   */
  @Override
  public String getServletInfo() {