src/plantuml.h

   1 /******************************************************************************
   2  *
   3  * Copyright (C) 1997-2014 by Dimitri van Heesch.
   4  *
   5  * Permission to use, copy, modify, and distribute this software and its
   6  * documentation under the terms of the GNU General Public License is hereby
   7  * granted. No representations are made about the suitability of this software
   8  * for any purpose. It is provided "as is" without express or implied warranty.
   9  * See the GNU General Public License for more details.
  10  *
  11  * Documents produced by Doxygen are derivative works derived from the
  12  * input used in their production; they are not affected by this license.
  13  *
  14  */
  15
  16 #ifndef PLANTUML_H
  17 #define PLANTUML_H
  18
  19 class QCString;
  20
  21 /** Plant UML output image formats */
  22 enum PlantUMLOutputFormat { PUML_BITMAP, PUML_EPS, PUML_SVG };
  23
  24 /** Write a PlantUML compatible file.
  25  *  @param[in] outDir   the output directory to write the file to.
  26  *  @param[in] fileName the name of the file. If empty a name will be chosen automatically.
  27  *  @param[in] content  the contents of the PlantUML file.
  28  *  @returns The name of the generated file.
  29  */
  30 QCString writePlantUMLSource(const QCString &outDir,const QCString &fileName,const QCString &content);
  31
  32 /** Convert a PlantUML file to an image.
  33  *  @param[in] baseName the name of the generated file (as returned by writePlantUMLSource())
  34  *  @param[in] outDir   the directory to write the resulting image into.
  35  *  @param[in] format   the image format to generate.
  36  */
  37 void generatePlantUMLOutput(const char *baseName,const char *outDir,PlantUMLOutputFormat format);
  38
  39 #endif
  40