octoleo/plantuml
1
0
Fork 0
mirror of https://github.com/octoleo/plantuml.git synced 2024-11-25 06:17:33 +00:00
Code Issues Releases Wiki Activity

Document base package

Browse Source
This commit is contained in:
Benjamin Davies 2023-08-26 14:50:34 +12:00
parent 1d1daf492b
commit cbab1c333f
No known key found for this signature in database
GPG Key ID: 9FFDE0674336C460
3 changed files with 67 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/net/sourceforge/plantuml/SourceFileReader.java
View File

@ -147,7 +147,7 @@ public class SourceFileReader extends SourceFileReaderAbstract implements ISourc
suggested = SuggestedFile.fromOutputFile(new File(outputDirectory, newName),
getFileFormatOption().getFileFormat(), 0);
} else {
Log.info("We are going to create files in directory " + dir);
Log.info("We are going to create cypherfiles in directory " + dir);
suggested = SuggestedFile.fromOutputFile(new File(dir, getFileName()),
getFileFormatOption().getFileFormat(), 0);
}

65
src/net/sourceforge/plantuml/package-info.java Normal file
View File

@ -0,0 +1,65 @@
/* ========================================================================
* PlantUML : a free UML diagram generator
* ========================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/paypal
*
* This file is part of PlantUML.
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
*
* Original Author: Benjamin Davies
*
*
*/
/**
* Contains classes for processing PlantUML source files.
*
* <p>
* The following is a typical control flow PlantUML:
*
* <ul>
* <li>
* Arguments are parsed ({@link Run} constructs {@link Option}),
* </li>
* <li>
* Files are read ({@link Run} constructs {@link SourceFileReaderAbstract}),
* </li>
* <li>
* Files are split into blocks ({@link SourceFileReaderAbstract} constructs
* {@link BlockUmlBuilder}),
* <li>
* Blocks are pre-processed ({@link BlockUml} uses
* {@link net.sourceforge.plantuml.tim.TimLoader}),
* </li>
* <li>
* Blocks are processed and the output images saved ({@link Run} calls
* {@link SourceFileReaderAbstract#getGeneratedImages()} which calls
* {@link BlockUml#getDiagram()} which uses
* {@link PSystemBuilder}),
* </li>
* </ul>
*/
package net.sourceforge.plantuml;

2
src/net/sourceforge/plantuml/regex/package-info.java
View File

@ -46,7 +46,7 @@
* Before a {@link RegexComposed} can be matched, it must first have each
* of its constituent parts concatenated into one large regex string using
* {@link RegexComposed#getFullSlow}. This string is then transformed by
* {@link MyPattern.transform} to replace some macros (e.g. %s
* {@link MyPattern#transform} to replace some macros (e.g. %s
* for whitespace, %q for single quote) and compiled using
* {@link java.util.regex.Pattern#compile}.
*/