[jira] [Commented] (RAT-358) Update documentation to match configuration options and files

[Claude Warren (Jira)]

    [ 
https://issues.apache.org/jira/browse/RAT-358?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17809115#comment-17809115
 ] 

Claude Warren commented on RAT-358:
-----------------------------------

Documentation should explain the following items in the configuration file.

 

<matcherRef refId="ALStandard" />

 
{color:#000000}<{color}{color:#000000}approved{color}{color:#000000}>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'AL'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}"BSD-3"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'CDDL1'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'GEN'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'GPL1'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'GPL2'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'GPL3'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'MIT'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'OASIS'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'W3C'{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}family{color} 
{color:#7f0055}license_ref{color}{color:#000000}={color}{color:#2a00ff}'W3CD'{color}
 {color:#000000}/>{color}

{color:#000000}</{color}{color:#000000}approved{color}{color:#000000}>{color}

{color:#000000}<{color}{color:#000000}matchers{color}{color:#000000}>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.AllBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.AnyBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.CopyrightBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.MatcherRefBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.NotBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.RegexBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.SpdxBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}<{color}{color:#000000}matcher{color} 
{color:#7f0055}class{color}{color:#000000}={color}{color:#2a00ff}"org.apache.rat.configuration.builders.TextBuilder"{color}
 {color:#000000}/>{color}

{color:#000000}</{color}{color:#000000}matchers{color}{color:#000000}>{color}

 

 

 

> Update documentation to match configuration options and files
> -------------------------------------------------------------
>
>                 Key: RAT-358
>                 URL: https://issues.apache.org/jira/browse/RAT-358
>             Project: Apache Rat
>          Issue Type: Improvement
>          Components: docs
>    Affects Versions: 0.16
>            Reporter: Claude Warren
>            Priority: Minor
>
> The documentation for the configuration file is not complete. 
> The documentation for the "generation-keywords" is not available
> The documentation for the "xsl" documents is not available.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)