Merge pull request #10005 from backstage/freben/comments

just fix some random ugly comments

packages/core-components/src/components/DependencyGraph/DependencyGraph.tsx

@@ -99,7 +99,7 @@ export interface DependencyGraphProps<NodeData, EdgeData>
   /**
    * Margin on top and bottom of whole graph
    *
-   *  @remarks
+   * @remarks
    *
    * Default: 0
    */

packages/test-utils/src/testUtils/logCollector.ts

@@ -18,37 +18,44 @@
 
 /**
  * Severity levels of {@link CollectedLogs}
- * @public */
+ * @public
+ */
 export type LogFuncs = 'log' | 'warn' | 'error';
 /**
  * AsyncLogCollector type used in {@link (withLogCollector:1)} callback function.
- * @public */
+ * @public
+ */
 export type AsyncLogCollector = () => Promise<void>;
 /**
  * SyncLogCollector type used in {@link (withLogCollector:2)} callback function.
- * @public */
+ * @public
+ */
 export type SyncLogCollector = () => void;
 /**
  * Union type used in {@link (withLogCollector:3)} callback function.
- * @public */
+ * @public
+ */
 export type LogCollector = AsyncLogCollector | SyncLogCollector;
 /**
  * Map of severity level and corresponding log lines.
- * @public */
+ * @public
+ */
 export type CollectedLogs<T extends LogFuncs> = { [key in T]: string[] };
 
 const allCategories = ['log', 'warn', 'error'];
 
 /**
  * Asynchronous log collector with that collects all categories
- * @public */
+ * @public
+ */
 export function withLogCollector(
   callback: AsyncLogCollector,
 ): Promise<CollectedLogs<LogFuncs>>;
 
 /**
  * Synchronous log collector with that collects all categories
- * @public */
+ * @public
+ */
 export function withLogCollector(
   callback: SyncLogCollector,
 ): CollectedLogs<LogFuncs>;
@@ -64,7 +71,8 @@ export function withLogCollector<T extends LogFuncs>(
 
 /**
  * Synchronous log collector with that only collects selected categories
- * @public */
+ * @public
+ */
 export function withLogCollector<T extends LogFuncs>(
   logsToCollect: T[],
   callback: SyncLogCollector,
@@ -73,7 +81,7 @@ export function withLogCollector<T extends LogFuncs>(
 /**
  * Log collector that collect logs either from a sync or async collector.
  * @public
- * */
+ */
 export function withLogCollector(
   logsToCollect: LogFuncs[] | LogCollector,
   callback?: LogCollector,

plugins/catalog-backend/src/ingestion/types.ts

@@ -62,7 +62,7 @@ export type AnalyzeLocationExistingEntity = {
  * enough info for the frontend to know what form data to show to the user
  * for overriding/completing the info.
  * @public
- * */
+ */
 export type AnalyzeLocationGenerateEntity = {
   // Some form of partial representation of the entity
   entity: RecursivePartial<Entity>;

plugins/catalog-backend/src/processing/types.ts

@@ -48,7 +48,7 @@ export type EntityProcessingResult =
 /**
  * Responsible for executing the individual processing steps in order to fully process an entity.
  * @public
- * */
+ */
 export interface CatalogProcessingOrchestrator {
   process(request: EntityProcessingRequest): Promise<EntityProcessingResult>;
 }
@@ -56,7 +56,7 @@ export interface CatalogProcessingOrchestrator {
 /**
  * Entities that are not yet processed.
  * @public
- * */
+ */
 export type DeferredEntity = {
   entity: Entity;
   locationKey?: string;

plugins/catalog-backend/src/service/types.ts

@@ -77,7 +77,8 @@ export interface RefreshService {
 
 /**
  * Interacts with the database to manage locations.
- * @public */
+ * @public
+ */
 export interface LocationStore {
   createLocation(location: LocationInput): Promise<Location>;
   listLocations(): Promise<Location[]>;

plugins/scaffolder-backend/src/scaffolder/actions/types.ts

@@ -26,7 +26,8 @@ import {
 
 /**
  * ActionContext is passed into scaffolder actions.
- * @public */
+ * @public
+ */
 export type ActionContext<Input extends JsonObject> = {
   /**
    * Base URL for the location of the task spec, typically the url of the source entity file.

plugins/tech-insights-node/src/facts.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import { DateTime, DurationLike } from 'luxon';
 import { Config } from '@backstage/config';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
@@ -62,11 +63,10 @@ export type TechInsightFact = {
 };
 
 /**
-
  * Response type used when returning from database and API.
  * Adds a field for ref for easier usage
  *
- *  @public
+ * @public
  */
 export type FlatTechInsightFact = TechInsightFact & {
   /**
@@ -76,12 +76,12 @@ export type FlatTechInsightFact = TechInsightFact & {
 };
 
 /**
- * @public
- *
  * A record type to specify individual fact shapes
  *
  * Used as part of a schema to validate, identify and generically construct usage implementations
  * of individual fact values in the system.
+ *
+ * @public
  */
 export type FactSchema = {
   /**
@@ -142,11 +142,9 @@ export type FactRetrieverContext = {
 };
 
 /**
- * @public
- *
  * FactRetriever interface
  *
- * A component specifying
+ * @public
  */
 export interface FactRetriever {
   /**
@@ -191,10 +189,9 @@ export interface FactRetriever {
 }
 
 /**
- * @public
- *
  * A Luxon duration like object for time to live value
  *
+ * @public
  * @example
  * \{ timeToLive: 1209600000 \}
  * \{ timeToLive: \{ weeks: 4 \} \}
@@ -203,10 +200,9 @@ export interface FactRetriever {
 export type TTL = { timeToLive: DurationLike };
 
 /**
- * @public
- *
  * A maximum number for items to be kept in the database for each fact retriever/entity pair
  *
+ * @public
  * @example
  * \{ maxItems: 10 \}
  *
@@ -214,25 +210,25 @@ export type TTL = { timeToLive: DurationLike };
 export type MaxItems = { maxItems: number };
 
 /**
- * @public
- *
  * A fact lifecycle definition. Determines which strategy to use to purge expired facts from the database.
+ *
+ * @public
  */
 export type FactLifecycle = TTL | MaxItems;
 
 /**
- * @public
- *
  * A flat serializable structure for Facts.
  * Containing information about fact schema, version, id, and entity filters
+ *
+ * @public
  */
 export type FactSchemaDefinition = Omit<FactRetriever, 'handler'>;
 
 /**
- * @public
- *
  * Registration of a fact retriever
  * Used to add and schedule individual fact retrievers to the fact retriever engine.
+ *
+ * @public
  */
 export type FactRetrieverRegistration = {
   /**

plugins/techdocs-backend/src/service/router.ts

@@ -347,8 +347,8 @@ export function createEventStream(
 }
 
 /**
- *  @deprecated use event-stream implementation of the sync endpoint
- * */
+ * @deprecated use event-stream implementation of the sync endpoint
+ */
 export function createHttpResponse(
   res: Response<any, any>,
 ): DocsSynchronizerSyncOpts {