Comments (4)
Thanks for your feedback.
Your settings look fine to me. Although you specify some options with their default value. So those could be removed.
So to break down the problems:
- SVG image is not displayed on the page
- Large diagram is cut off
- Wrong return value of methods
May I ask you to create a separate issue for each of these so we can look into them in a more organized manner? I think replying to all of these in one thread is going to be a messy thing. 🙄
May I ask you to includ the legend into the picture ?
What legend do you mean?
Could you generate into a seperate file the uml code compatible plantuml.
Yes, I didn't forget about that. It's on my feature TODO list. You might create a separate issue for this one if you like.
from typedoc-umlclass.
Thanks for taking the time and creating separate issue. I'll close this one.
from typedoc-umlclass.
Dear @krisztianb
This is my typedoc-umlclass settings
module.exports = {
inputFiles: ['./src/'],
mode: 'file',
//mode: 'modules',
includeDeclarations: true,
tsconfig: 'tsconfig.json',
out: './docs/dist/docs-class-diagram/',
excludePrivate: false,
excludeProtected: false,
excludeExternals: true,
readme: './README.md',
name: 'Probel SW-P-8 protocol Library project',
ignoreCompilerErrors: true,
plugin: 'typedoc-umlclass',
listInvalidSymbolLinks: true,
entryPoint: 'index',
categorizeByGroup: true,
media: './docs/dist/docs-class-diagram/assets',
version: '',
gitRemote: 'remote',
gitRevision: 'revision',
theme: 'default',
// Basic Settings
umlClassDiagramType: 'detailed',
umlClassDiagramLocation: 'embed',
//umlClassDiagramFormat: 'png',
umlClassDiagramFormat: 'svg',
// HTML output
umlClassDiagramSectionTitle: 'Class-Diagram',
umlClassDiagramPosition: 'above',
// Class diagram formating
umlClassDiagramMethodParameterOutput: 'complete',
umlClassDiagramHideEmptyMembers: 'false',
// umlClassDiagramTopDownLayoutMaxSiblings: 6,
umlClassDiagramMemberVisibilityStyle: 'icon',
umlClassDiagramHideCircledChar: 'false',
umlClassDiagramHideShadow: 'false',
//umlClassDiagramBoxBackgroundColor: transparent | #RGBHEX ,
//umlClassDiagramBoxBorderColor: transparent | #RGBHEX ,
umlClassDiagramBoxBorderRadius: 2,
//umlClassDiagramBoxBorderWidth: 1,
//umlClassDiagramArrowColor: #RGBHEX ,
umlClassDiagramClassFontName: 'Courier',
//umlClassDiagramClassFontSize: integer ,
umlClassDiagramClassFontStyle: 'bold',
//umlClassDiagramClassFontColor: transparent|#RGBHEX ,
//umlClassDiagramClassAttributeFontName: font-name ,
umlClassDiagramClassAttributeFontStyle: 'italic',
//umlClassDiagramClassAttributeFontColor: transparent|#RGBHEX,
// Other settings
umlClassDiagramHideProgressBar: true,
umlClassDiagramCreatePlantUmlFiles: true,
umlClassDiagramVerboseOutput: false
};
I am sure we could optimize for the color but enought at this stage.
Best regards,
Youssef
from typedoc-umlclass.
There are some options that you set with the default value. So you could remove those:
- umlClassDiagramVerboseOutput
- umlClassDiagramBoxBorderRadius (I think 2 is the default value - not sure)
- umlClassDiagramHideShadow
- umlClassDiagramHideCircledChar
- umlClassDiagramMemberVisibilityStyle
- umlClassDiagramMethodParameterOutput
- umlClassDiagramPosition
- umlClassDiagramType
The default value is listed in the README.
And of course you could also remove the ones that are commented out. If you need it, you can always find it in your version control tool (GIT).
from typedoc-umlclass.
Related Issues (20)
- Typedoc-plugin-pages supports HOT 4
- Interfaces and base classes are missing in the class diagram HOT 6
- Typedoc keeps hanging and generates a lot of logs HOT 4
- Support generics/template classes HOT 1
- When diagram generation fails typedoc hangs HOT 2
- Failure to load module with error for umlClassDiagramBoxBorderWidth value HOT 8
- Sort class members by visibility HOT 1
- Maximum call stack size exceeded HOT 6
- markdown table not rendered correctly HOT 1
- Add support for PlantUML picoweb HOT 1
- Move options into object HOT 1
- Automatically determine number of CPUs HOT 1
- TypeDoc 0.24.x support HOT 2
- TypeDoc 0.25.x support HOT 6
- Format functions in diagrams HOT 2
- Monorepo support with typedoc config "entryPointStrategy": "packages" HOT 4
- Wrong return value of methods HOT 8
- Legend definition if using icon instead of text HOT 7
- Extend option umlClassDiagramLocation to embed images in the HTML HOT 3
- Class Name instead of umlClassDiagram-xxx.png or .svg HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typedoc-umlclass.