docs/Description_schema.html

<!-- Copyright (c) 2010-2026 Arm Limited or its affiliates. All rights reserved. -->
<!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <!--FAVICON.ico-->
    <meta name="msapplication-TileColor" content="#2b5797">
    <meta name="msapplication-TileImage" content="./img/mstile-144x144.png">
    <link rel="icon" href="./img/favicon.ico">

        <title>Description - ARM Machine Readable Schema - 2.9.6</title>

    <!--CSS-->
    <link rel="stylesheet" type="text/css" href="./css/bootstrap.min.css">
    <link rel="stylesheet" type="text/css" href="./css/schema.css">
    <link rel="stylesheet" type="text/css" href="./css/hljs-github.css">
</head>
<body>
    <div class="container">
        <div class="row heading">
            <div class="col-md-6 pull-left"><a href="./index.html"><img src="./img/arm.svg" class="logo" /></a></div>
            <div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.9.6</small></h1></div>

                <!--Show the home button-->
                <a href="./index.html"><div class="back-to-home">&nlarr; Home</div></a>
        </div>
    </div>

    <div class="container">
        


















<div class="row">
    
    
    
            
        <h2>
                <span class=" title-type">Description</span>

            <!-- if oneOf is set, then type is ignored -->
                <span class="type">object</span>
        </h2>


    

    <div class="static-markdown"><p>The <a class="schema_link" href="Description_schema.html" title="Description">Description</a> type is mainly used when you want to render descriptive contextual information before 
and/or after the autogenerated component of a schema model.</p>
<p>When a model that contains a <a class="schema_link" href="Description_schema.html" title="Description">Description</a> is rendered in documentation, the 
contents of the <a class="schema_link" href="Description_schema.html" title="Description">Description</a>.<code>before</code> property are rendered, followed by the 
contents of the model, and then the contents of the <a class="schema_link" href="Description_schema.html" title="Description">Description</a>.<code>after</code> property.</p></div>
</div>






<div class="row">

    <div>
            <!-- A simple object -->
                <h3 class="type">object</h3>
                
    <table class="table table-hover properties">
        <thead>
            <tr>
                <th class="col-md-4">Properties</th>
                <th class="col-md-4">Type</th>
                <th class="col-md-4">Description</th>
            </tr>
        </thead>
        <tbody>

            <!-- properties -->
                
        
        <tr id="/properties/_meta" class="property">
                <th class="col-md-4">
                <a href="#/properties/_meta">_meta</a>
            </th>
            <td class="col-md-4">
                    <a href="Meta_schema.html" class="schema_link">Meta</a>
            </td>
            <td class="col-md-4">
                    
    <div>
        See
            <a href="Meta_schema.html" class="schema_link">Meta</a>
        for more information.
    </div>

                


            </td>
        </tr>
        
        <tr id="/properties/_type" class="property">
                <th class="col-md-4">
                <a href="#/properties/_type">_type</a>
            </th>
            <td class="col-md-4">
            </td>
            <td class="col-md-4">
                    <dl>
                        <dt>Enum</dt>
                        <dd>
                            <code>Description</code>
                        </dd>
                    </dl>
                


            </td>
        </tr>
        
        <tr id="/properties/after" class="property">
                <th class="col-md-4">
                <a href="#/properties/after">after</a>
            </th>
            <td class="col-md-4">
                    <a href="Text_schema.html" class="schema_link">Text</a>
            </td>
            <td class="col-md-4">
                    <div><p>This text appears after the content of the parent model.</p></div>
                    
    <div>
        See
            <a href="Text_schema.html" class="schema_link">Text</a>
        for more information.
    </div>

                


            </td>
        </tr>
        
        <tr id="/properties/before" class="property">
                <th class="col-md-4">
                <a href="#/properties/before">before</a>
            </th>
            <td class="col-md-4">
                    <a href="Text_schema.html" class="schema_link">Text</a>
            </td>
            <td class="col-md-4">
                    <div><p>This text appears before the content of the parent model.</p></div>
                    
    <div>
        See
            <a href="Text_schema.html" class="schema_link">Text</a>
        for more information.
    </div>

                


            </td>
        </tr>


            <!-- patternProperties -->

            <!-- object property attributes -->
            <tr>
                <td colspan="3">
                    <dl>
                        <dt>Additional Properties</dt>
                        <dd>Not Allowed</dd>
                    </dl>
                </td>
            </tr>

                <tr>
                    <td colspan="3">
                        <dl>
                            <dt>&loz; Required</dt>
                            <dd>Properties marked with &loz; are required properties.</dd>
                        </dl>
                    </td>
                </tr>
        </tbody>
    </table>




            <!-- array, and it has described items -->
    </div>

    
        <h5>Examples</h5>
        <div>
            <pre class="schema-json"><code class="language-json">{
    &#34;_type&#34;: &#34;Description&#34;, 
    &#34;before&#34;: [
        &#34;Multiline Text that appears before the content of the model that contains this Description.&#34;, 
        &#34;This is a $(Text) object, so can use any formatting permitted in a Text object.&#34;
    ], 
    &#34;after&#34;: &#34;Text that appears after the parent model&#39;s content&#34;
}</code></pre>
            <pre class="schema-json"><code class="language-json">{
    &#34;_type&#34;: &#34;Description&#34;, 
    &#34;before&#34;: null, 
    &#34;after&#34;: [
        &#34;Text for a context that only has `after` content &#34;, 
        &#34;which appears after the parent model&#39;s content&#34;
    ]
}</code></pre>
        </div>




</div>

<div class="row schema">
        <h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3>
    <pre class="schema-json"><code class="language-json">{
  "info": [
    [
      "The $(Description) type is mainly used when you want to render descriptive contextual information before ",
      "and/or after the autogenerated component of a schema model."
    ],
    [
      "When a model that contains a $(Description) is rendered in documentation, the ",
      "contents of the $(Description).`before` property are rendered, followed by the ",
      "contents of the model, and then the contents of the $(Description).`after` property."
    ]
  ],
  "title": "Description",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_meta": {
      "$ref": "Meta.json"
    },
    "_type": {
      "enum": [
        "Description"
      ]
    },
    "after": {
      "$ref": "Text.json",
      "info": [
        "This text appears after the content of the parent model."
      ]
    },
    "before": {
      "$ref": "Text.json",
      "info": [
        "This text appears before the content of the parent model."
      ]
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "_type": "Description",
      "before": [
        "Multiline Text that appears before the content of the model that contains this Description.",
        "This is a $(Text) object, so can use any formatting permitted in a Text object."
      ],
      "after": "Text that appears after the parent model's content"
    },
    {
      "_type": "Description",
      "before": null,
      "after": [
        "Text for a context that only has `after` content ",
        "which appears after the parent model's content"
      ]
    }
  ]
}</code></pre>
</div>

    </div>

    <div class="container">
        <div class="footer text-right">
            Copyright &copy; 2025 ARM Limited or its affiliates. All rights reserved.
        </div>
    </div>

    <script src="./js/highlight/highlight.js"></script>
    <script src="./js/highlight/languages/json.min.js"></script>
    <script src="./js/highlight/languages/django.min.js"></script> <!-- JINJA2 -->
    <script src="./js/highlight/languages/yaml.min.js"></script>
    <script src="./js/highlight/languages/isa.js"></script>
    <script type="text/javascript">
        window.onload = function() {
            hljs.configure({
              cssSelector: ".schema-json code, .includes code, pre code",
              noHighlightRe: /^(no-?highlight|nohl)$/i,
            });
            hljs.highlightAll()
        };
    </script>

</body>
</html>