diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2019-06-23 18:15:44 (GMT) |
---|---|---|
committer | Dimitri van Heesch <doxygen@gmail.com> | 2019-06-23 18:50:56 (GMT) |
commit | 6fb61b2c6561149c1a318df26fd1acac619b3519 (patch) | |
tree | ad73d56e94aebbd888db4077bc367895fbb8ad83 /libmscgen/mscgen_api.h | |
parent | 15678e7ccb524af8c90a4018f3b882ba184e6a39 (diff) | |
download | Doxygen-6fb61b2c6561149c1a318df26fd1acac619b3519.zip Doxygen-6fb61b2c6561149c1a318df26fd1acac619b3519.tar.gz Doxygen-6fb61b2c6561149c1a318df26fd1acac619b3519.tar.bz2 |
issue #6880 mscgen links placed in the wrong place when using SVG output
Diffstat (limited to 'libmscgen/mscgen_api.h')
-rw-r--r-- | libmscgen/mscgen_api.h | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/libmscgen/mscgen_api.h b/libmscgen/mscgen_api.h new file mode 100644 index 0000000..3d294a1 --- /dev/null +++ b/libmscgen/mscgen_api.h @@ -0,0 +1,41 @@ +#ifndef MSCGEN_API_H +#define MSCGEN_API_H + +#ifdef __cplusplus +extern "C" { +#endif + +#define MSCGEN_OK ( 0) +#define MSCGEN_FILE_ERROR (-1) +#define MSCGEN_INPUT_FORMAT_ERROR (-2) +#define MSCGEN_OUTPUT_CONTEXT_ERROR (-3) + +/** The supported image formats */ +typedef enum +{ + mscgen_format_png, /**< PNG bitmap image file */ + mscgen_format_eps, /**< Encapsulated PostScript file */ + mscgen_format_svg, /**< Scalable Vector Graphics file */ + mscgen_format_pngmap, /**< Image map for a bitmap file */ + mscgen_format_svgmap /**< Image map for a SVG file */ +} mscgen_format_t; + +/** generate an image file for a given .msc file. + * @param inputFile the name of the MSC file to process. + * @param outputFile the name of the image file to generate. + * @param fomat the format of the image file to generate. + * @return 0 on success, a non zero error code on failure. + */ +int mscgen_generate(const char *inputFile, + const char *outputFile, + mscgen_format_t format + ); + +/** Translates the error code returned by mscgen_generate into a string */ +const char *mscgen_error2str(int code); + +#ifdef __cplusplus +} +#endif + +#endif // MSCGEN_API_H |