Variable DOCUMENTATION_MISMATCHConst

Type Declaration

• ReadonlycreateSearch: () => FlowrSearchBuilder<
      "from-query",
      [],
      ParentInformation,
      FlowrSearchElements<ParentInformation, (...)[]>,
  >

• Readonlyinfo: {
      certainty: BestEffort;
      defaultConfig: () => {
          checkCodoc: true;
          checkDefaults: true;
          checkInternalUsage: false;
          checkUndocumented: true;
          checkUsage: true;
          requireDocumentation: true;
      };
      description: "Finds exported objects without documentation, functions whose formals differ from their `\\usage`, and arguments missing from or extra in `\\arguments`.";
      name: "Documentation Mismatch";
      tags: readonly [CmdCheck, Documentation, Bug];
  }

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

• ReadonlyprocessSearchResult: (
      _elements: FlowrSearchElements<
          ParentInformation,
          FlowrSearchElement<(...)>[],
      >,
      config: DocumentationMismatchConfig,
      data: ReadonlyFlowrAnalysisProvider<KnownParser>,
  ) => Promise<
      {
          ".meta": { consideredObjects: ...; consideredPages: ... };
          results: (...)[];
      },
  >