Variable ROXYGEN_ARGSConst

Type Declaration

• ReadonlycreateSearch: () => FlowrSearchBuilderOut<"all", ["filter"], ParentInformation, "with">

• Readonlyinfo: {
      certainty: BestEffort;
      defaultConfig: () => {};
      description: "Finds function parameters the roxygen documentation leaves out, and documented parameters the function does not have.";
      name: "Roxygen Arguments";
      tags: readonly [Smell, Documentation];
  }

• ReadonlyprettyPrint: {
      full: (result: RoxygenArgsResult) => string;
      query: (result: RoxygenArgsResult) => string;
  }

• ReadonlyprocessSearchResult: (
      elements: FlowrSearchElements<
          ParentInformation,
          FlowrSearchElement<(...)>[],
      >,
  ) => {
      ".meta": {};
      results: {
          certainty: ...;
          involvedId: ...;
          loc: ...;
          overDocumented: ...;
          underDocumented: ...;
      }[];
  }