By default, the preferences are set up so that Developer Comment and User Documentation nodes appear under the nodes in the interface that needs comments and documentation. You can change this in the Preferences dialog box under Comments and documentation on the Physics Builder page. For the user documentation, a default User Documentation text node is added automatically under the main User Documentation node, but you can add any other documentation components such as equations, images, notes, and tables. The main User Documentation node adds a heading and the topic description used for the context help when clicking the node in the COMSOL Desktop.
When you have created the documentation contents, right-click the main Physics Interface node and select Compile Documentation (
) to compile the documentation from the various User Documentation nodes into a complete document that appears under the Documentation node (
) at the bottom of the tree in the Physics Builder window. Under Documentation you can add additional documentation components to describe parts of the physics that are not directly connected to the nodes for the interface such as an introduction or a theory section.
) to compile the documentation from the various User Documentation nodes into a complete document that appears under the Documentation node () at the bottom of the tree in the Physics Builder window. Under Documentation you can add additional documentation components to describe parts of the physics that are not directly connected to the nodes for the interface such as an introduction or a theory section.