Skip to content

Commit

Permalink
finished adding descriptions to settings
Browse files Browse the repository at this point in the history
  • Loading branch information
rhit-shirakrk committed May 14, 2024
1 parent ab6b363 commit 4491613
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/main/resources/config-spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@
"type": "String[]",
"desc": "List of user-specified allowed dependencies (add known interfaces and/or data classes here)."
}
]
],
"desc": "Checks for classes who program to concrete implementations rather than interfaces. Programming to interfaces generally provides more flexibility in applications."
},
{
"title": "Low Coupling",
Expand Down Expand Up @@ -183,7 +184,8 @@
"type": "boolean",
"desc": "Specifies whether Classes that reference themselves will be reported (cycles like A → A). Defaults to true."
}
]
],
"desc": "Checks for classes who are too closely dependent on one another, when alternative solutions allowing such classes to exist more independently are available."
},
{
"title": "Strategy Pattern",
Expand All @@ -209,7 +211,8 @@
"type": "boolean",
"desc": "Specifies whether to check for patterns with only a concrete subject, and no abstract subject."
}
]
],
"desc": "Checks if classes properly implement ways to notify multiple objects about events its observing. The observer pattern allows classes to subscribe and unsubscribe from watching for a certain event."
},
{
"title": "Adapter Pattern",
Expand All @@ -225,7 +228,8 @@
"type": "boolean",
"desc": "If true, interfaces with no fields nor methods (\"marker interfaces\") will be ignored. (Defaults to false.)"
}
]
],
"desc": "Checks for any interfaces that contains only fields and no methods. This is similar to Data Classes."
},
{
"title": "PlantUML Generator",
Expand Down

0 comments on commit 4491613

Please sign in to comment.