• Chapter 1: Getting Started with Stylus Studio®
• Chapter 2: Editing and Querying XML
• Chapter 3: Converting Non-XML Files to XML
• Chapter 4: Working with XSLT
• Chapter 5: Creating XSLT Using the XSLT Mapper
• Chapter 6: Debugging Stylesheets
• Chapter 7: Defining XML Schemas
• Chapter 8: Defining Document Type Definitions
• Chapter 9: Writing XPath Expressions
• Chapter 10: Working with XQuery in Stylus Studio
  • Getting Started with XQuery in Stylus Studio
  • An XQuery Primer
  • Understanding FLWOR Expressions
  • Building an XQuery Using the Mapper
  • Working with the XQuery collection() Function
  • Debugging XQuery Documents
  • Using DataDirect XQuery® Execution Plans
  • Creating an XQuery Scenario
  • Generating XQuery Documentation
    • Documentation Defaults
    • Syntax and Usage
      • Save the XQuery Document
      • ActiveX Controls
      • Viewing Code Samples
    • How to Generate XQuery Documentation
  • Using XQuery to Invoke a Web Service
  • Using Web Services in XQuery
  • Generating Java Code for XQuery
  • Generating C# Code for XQuery
• Chapter 11: Composing Web Service Calls
• Chapter 12: Working with WSDL Documents
• Chapter 13: Building XML Pipelines
• Chapter 14: Publishing XML Data
• Chapter 15: Integrating with Third-Party File Systems
• Chapter 16: Extending Stylus Studio
• Chapter 17: The Stylus Studio Java API
• Chapter 18: Stylus Studio GUI Reference

Home > Online Product Documentation > Table of Contents > Syntax and Usage

Syntax and Usage

Comments for xqDoc must start with (:~ and end with :). Comments can span multiple lines. New lines do not need to be introduced with a special character. You can use <br/> to force a line break, which you might want to do to aid readability. Comments that start with (: (standard XQuery syntax) are ignored by xqDoc.

The first comment in an XQuery document is interpreted by xqDoc as the Module Description. Within that comment, xqDoc recognizes certain keywords preceded by the at (@) sign. Examples include @author and @version. See the xqDoc documentation at http://www.xqdoc.org for more information. Here is a report for the same document shown in Figure 339 with a user-defined module and function descriptions.

All other comments must precede function declarations. xqDoc uses the text you enter to provide a description for each function listed in the Function Summary. The same description is used in the Function Detail. Here is an illustration of the XQuery document in the XQuery Editor; the xqDoc comments are highlighted:

Save the XQuery Document

When you annotate an XQuery document using xqDoc comments, make sure to save the XQuery document before generating documentation. Unsaved work is not detected by the report generating mechanism.

ActiveX Controls

xqDoc reports use ActiveX controls for navigation and code sample generation. Make sure to enable ActiveX controls for the browser displaying the xqDoc report.

Viewing Code Samples

You can view code samples from an xqDoc report by clicking the view code hyperlink, as shown in the following illustration.

The XQuery code sample appears in a separate Web browser.