|
Packit Service |
50c9f2 |
/******************************************************************************
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Copyright (C) 1997-2015 by Dimitri van Heesch.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Permission to use, copy, modify, and distribute this software and its
|
|
Packit Service |
50c9f2 |
* documentation under the terms of the GNU General Public License is hereby
|
|
Packit Service |
50c9f2 |
* granted. No representations are made about the suitability of this software
|
|
Packit Service |
50c9f2 |
* for any purpose. It is provided "as is" without express or implied warranty.
|
|
Packit Service |
50c9f2 |
* See the GNU General Public License for more details.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Documents produced by Doxygen are derivative works derived from the
|
|
Packit Service |
50c9f2 |
* input used in their production; they are not affected by this license.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
*/
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#ifndef PLANTUML_H
|
|
Packit Service |
50c9f2 |
#define PLANTUML_H
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
class QCString;
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** Plant UML output image formats */
|
|
Packit Service |
50c9f2 |
enum PlantUMLOutputFormat { PUML_BITMAP, PUML_EPS, PUML_SVG };
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** Write a PlantUML compatible file.
|
|
Packit Service |
50c9f2 |
* @param[in] outDir the output directory to write the file to.
|
|
Packit Service |
50c9f2 |
* @param[in] fileName the name of the file. If empty a name will be chosen automatically.
|
|
Packit Service |
50c9f2 |
* @param[in] content the contents of the PlantUML file.
|
|
Packit Service |
50c9f2 |
* @returns The name of the generated file.
|
|
Packit Service |
50c9f2 |
*/
|
|
Packit Service |
50c9f2 |
QCString writePlantUMLSource(const QCString &outDir,const QCString &fileName,const QCString &content);
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** Convert a PlantUML file to an image.
|
|
Packit Service |
50c9f2 |
* @param[in] baseName the name of the generated file (as returned by writePlantUMLSource())
|
|
Packit Service |
50c9f2 |
* @param[in] outDir the directory to write the resulting image into.
|
|
Packit Service |
50c9f2 |
* @param[in] format the image format to generate.
|
|
Packit Service |
50c9f2 |
*/
|
|
Packit Service |
50c9f2 |
void generatePlantUMLOutput(const char *baseName,const char *outDir,PlantUMLOutputFormat format);
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#endif
|
|
Packit Service |
50c9f2 |
|