tools/model-detail/src/docs/model-detail.txt

///////////////////////////////////////////////////////////////
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
///////////////////////////////////////////////////////////////

[[tools-model-detail,Detailed Application Model]]
= Detailed Application Model =

For troubleshooting it can be handy to log the application model, or write it to some file, when activating an application.

This library is what <<tools-envisage>> uses under the hood.

include::../../build/docs/buildinfo/artifact.txt[]

== Usage ==

On application bootstrap:

[snippet,java]
----
source=tools/model-detail/src/test/java/org/apache/polygene/tools/model/DocumentationSupport.java
tag=usage
----

    . Given an application assembler,
    . and a Polygene runtime,
    . create the `ApplicationModel`.
    . Use the `createApplicationDetailDescriptor()` static method to create a detailed application model object.
    . Use its `toJson()` method to get a detailed report of the application model.
    . Continue with regular application activation.

Here is what a sample JSON dump looks like:

[snippet,javascript]
----
source=tools/model-detail/src/test/resources/doc-support-report.json
tag=report
----