Uses of Record Class
network.ike.docs.plugin.registry.TopicHeader
Packages that use TopicHeader
-
Uses of TopicHeader in network.ike.docs.plugin.packages
Methods in network.ike.docs.plugin.packages that return types with arguments of type TopicHeaderModifier and TypeMethodDescriptionAdocPackages.Package.files()Returns the value of thefilesrecord component.static List<TopicHeader> Parse the header of every.adocfile under a directory, in path order, paths relative to the root; symbolic links and the directoriesTopicRegistry.SKIPPED_DIRSare left out.AdocPackages.Package.topics()The files that declare a:topic-id:.Constructor parameters in network.ike.docs.plugin.packages with type arguments of type TopicHeaderModifierConstructorDescriptionPackage(String name, String domain, Path directory, PackageKind kind, List<TopicHeader> files) Creates an instance of aPackagerecord class. -
Uses of TopicHeader in network.ike.docs.plugin.registry
Methods in network.ike.docs.plugin.registry that return TopicHeaderModifier and TypeMethodDescriptionstatic TopicHeaderParse file content already in memory.static TopicHeaderParse one file.Methods in network.ike.docs.plugin.registry that return types with arguments of type TopicHeaderModifier and TypeMethodDescriptionstatic List<TopicHeader> Add files to an existing registry, or refresh their entries, without rescanning the roots: each file is parsed alone, placed in its domain in id order, counted, and checked for a duplicate id against the ids the registry already holds.TopicRegistry.Scan.others()Returns the value of theothersrecord component.TopicRegistry.Scan.topics()Returns the value of thetopicsrecord component.Methods in network.ike.docs.plugin.registry with parameters of type TopicHeaderModifier and TypeMethodDescriptionTopicRegistry.otherEntry(TopicHeader o, String fileValue) An assembly or plain file: its path, title, document attributes and include count.TopicRegistry.topicEntry(TopicHeader t, String fileValue) One topic in the registry's field order (id,file,title,type,keywords,status,char-count,dependencies,related,summary,supersedes,notes), then what the header adds: provenance, scope note, citation, license, the anchor and header verdicts, unknown:topic-*:attributes underextra, document attributes, and the include count.Constructor parameters in network.ike.docs.plugin.registry with type arguments of type TopicHeaderModifierConstructorDescriptionScan(Path root, List<TopicHeader> topics, List<TopicHeader> others, List<String> findings) Creates an instance of aScanrecord class.