From 315925024085eff92c0700a49d8e203223822118 Mon Sep 17 00:00:00 2001 From: anquetil Date: Mon, 8 Jan 2024 15:23:23 +0100 Subject: [PATCH] Only adding some class comments --- .../FamixUMLDocumentor.class.st | 14 +++++++++++--- .../FamixUMLPlantUMLBackend.class.st | 5 +++++ 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/src/Famix-UMLDocumentor/FamixUMLDocumentor.class.st b/src/Famix-UMLDocumentor/FamixUMLDocumentor.class.st index bab347fe..996b14f0 100644 --- a/src/Famix-UMLDocumentor/FamixUMLDocumentor.class.st +++ b/src/Famix-UMLDocumentor/FamixUMLDocumentor.class.st @@ -1,7 +1,7 @@ " A Tool to generate an UML representation of Famix meta-models -Simple use: +## Simple use: ``` FamixUMLDocumentor new model: FamixStModel ; @@ -9,7 +9,7 @@ FamixUMLDocumentor new exportWith: (FamixUMLPlantUMLBackend new). ``` -API: +## API: - `model:` adds a meta-model to export (entities of the meta-model will have an automatically assigned color) several meta-models can be specified - `model:color:` same as previous but manually assign a color to the entities of this meta-model @@ -18,7 +18,15 @@ API: - `beWithStubs` also export the super-classes and used traits of classes exported, even if these super-classes/traits or not part of the meta-models. These stubs have an automatically selected color. - `beWithoutStubs` opposite of the preceding, default option - `generate` creates an internal representation of a UML class diagram according to the options given before -- `exportWith:` exports the internal representation with the ""backend"" given (see `FamixUMLDummyBackend`) +- `exportWith:` exports the internal representation with the ""backend"" given + +## Backends + +The backends export the model in some specific format. +- `FamixUMLTextBackend`: exports a textual description of the model +- `FamixUMLPlantUMLBackend`: exports a description of the model in PlantUML format +- `FamixUMLMermaidBackend`: exports a textual description of the model in Mermaid format +- `FamixUMLRoassalBackend`: creates a Roassal representation of the model (work in progress) " Class { #name : #FamixUMLDocumentor, diff --git a/src/Famix-UMLDocumentor/FamixUMLPlantUMLBackend.class.st b/src/Famix-UMLDocumentor/FamixUMLPlantUMLBackend.class.st index 2d536e20..4b7b8faf 100644 --- a/src/Famix-UMLDocumentor/FamixUMLPlantUMLBackend.class.st +++ b/src/Famix-UMLDocumentor/FamixUMLPlantUMLBackend.class.st @@ -1,3 +1,8 @@ +" +I export the model in PlantUML format. + +The result can be given to [PlantUML.com](https://plantuml.com) to generate a graphical representation of the class diagram +" Class { #name : #FamixUMLPlantUMLBackend, #superclass : #FamixUMLTextBackend,