VirtualBox

Ignore:
Timestamp:
Nov 5, 2019 8:38:33 PM (5 years ago)
Author:
vboxsync
Message:

Main/idl: documentation fixes (almost all doxygen warnings fixed, and at least not worse javadoc)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r81685 r81687  
    18961896    <const name="NISServers"              value="41"><desc>Space separated list of IPv4 NIS server addresses.</desc></const>
    18971897    <const name="NTPServers"              value="42"><desc>Space separated list of IPv4 NTP (RFC1035) server addresses.</desc></const>
    1898     <const name="VendorSpecificInfo"      value="43"><desc>Vendor specific information. Only accessible using <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     1898    <const name="VendorSpecificInfo"      value="43"><desc>Vendor specific information. Only accessible using <link to="DHCPOptionEncoding_Hex"/>.</desc></const>
    18991899    <const name="NetBIOSNameServers"      value="44"><desc>Space separated list of IPv4 NetBIOS name server (NBNS) addresses (RFC1001,RFC1002).</desc></const>
    19001900    <const name="NetBIOSDatagramServers"  value="45"><desc>Space separated list of IPv4 NetBIOS datagram distribution server (NBDD) addresses (RFC1001,RFC1002).</desc></const>
    19011901    <const name="NetBIOSNodeType"         value="46"><desc>NetBIOS node type (RFC1001,RFC1002): 1=B-node, 2=P-node, 4=M-node, and 8=H-node (8-bit decimal value).</desc></const>
    1902     <const name="NetBIOSScope"            value="47"><desc>NetBIOS scope (RFC1001,RFC1002). Only accessible using <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     1902    <const name="NetBIOSScope"            value="47"><desc>NetBIOS scope (RFC1001,RFC1002). Only accessible using <link to="DHCPOptionEncoding_Hex"/>.</desc></const>
    19031903    <const name="XWindowsFontServers"     value="48"><desc>Space separated list of IPv4 X windows font server addresses.</desc></const>
    19041904    <const name="XWindowsDisplayManager"  value="49"><desc>Space separated list of IPv4 X windows display manager addresses.</desc></const>
    19051905    <!-- Options 50 thru 59 are considered DHCP internal and currently not settable. -->
    19061906    <const name="NetWareIPDomainName"     value="62"><desc>Netware IP domain name (RFC2242) (string).</desc></const>
    1907     <const name="NetWareIPInformation"    value="63"><desc>Netware IP information (RFC2242). Only accessible using <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     1907    <const name="NetWareIPInformation"    value="63"><desc>Netware IP information (RFC2242). Only accessible using <link to="DHCPOptionEncoding_Hex"/>.</desc></const>
    19081908    <const name="NISPlusDomain"           value="64"><desc>The NIS+ domain name (string).</desc></const>
    19091909    <const name="NISPlusServers"          value="65"><desc>Space separated list of IPv4 NIS+ server addresses.</desc></const>
    … …  
    19201920    <const name="STDAServers"             value="76"><desc>Space separated list of IPv4 StreetTalk directory assistance (STDA) server addresses.</desc></const>
    19211921    <!-- 77 is client only -->
    1922     <const name="SLPDirectoryAgent"       value="78"><desc>Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible using <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
    1923     <const name="SLPServiceScope"         value="79"><desc>List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible using <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     1922    <const name="SLPDirectoryAgent"       value="78"><desc>Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible using <link to="DHCPOptionEncoding_Hex"/>.</desc></const>
     1923    <const name="SLPServiceScope"         value="79"><desc>List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible using <link to="DHCPOptionEncoding_Hex"/>.</desc></const>
    19241924    <!-- 80 is client only -->
    1925     <const name="DomainSearch"            value="119"><desc>Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding.  Only accessible using <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     1925    <const name="DomainSearch"            value="119"><desc>Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding.  Only accessible using <link to="DHCPOptionEncoding_Hex"/>.</desc></const>
    19261926  </enum>
    19271927
    … …  
    22132213        <desc>
    22142214          Meaning depends on the @a scope:
    2215             - Ignored when the @a scope is <link to="DHCPConfigScope::Global"/>.
    2216             - A VM name or UUID for <link to="DHCPConfigScope::MachineNIC"/>.
    2217             - A MAC address for <link to="DHCPConfigScope::MAC"/>.
    2218             - A group name for <link to="DHCPConfigScope::Group"/>.
     2215            - Ignored when the @a scope is <link to="DHCPConfigScope_Global"/>.
     2216            - A VM name or UUID for <link to="DHCPConfigScope_MachineNIC"/>.
     2217            - A MAC address for <link to="DHCPConfigScope_MAC"/>.
     2218            - A group name for <link to="DHCPConfigScope_Group"/>.
    22192219        </desc>
    22202220      </param>
    22212221      <param name="slot"   dir="in" type="unsigned long">
    2222         <desc>The NIC slot when @a scope is set to <link to="DHCPConfigScope::MachineNIC"/>,
     2222        <desc>The NIC slot when @a scope is set to <link to="DHCPConfigScope_MachineNIC"/>,
    22232223          must be zero for all other scope values.
    22242224        </desc>
    … …  
    22932293        <desc>The DHCP option value.  The exact format depends on the DHCP
    22942294          @a option value and @a encoding, see see <link to="DHCPOption"/>
    2295           for the <link to="DHCPOptionEncoding::Normal"/> format.
     2295          for the <link to="DHCPOptionEncoding_Normal"/> format.
    22962296         </desc>
    22972297      </param>
    … …  
    23242324        <desc>The value of the requested DHCP option. The exact format depends on
    23252325          the DHCP @a option value and the @a encoding, see <link to="DHCPOption"/>
    2326           for the <link to="DHCPOptionEncoding::Normal"/> format.
     2326          for the <link to="DHCPOptionEncoding_Normal"/> format.
    23272327        </desc>
    23282328      </param>
    … …  
    24352435    <attribute name="MACAddress" type="wstring" readonly="yes">
    24362436      <desc>
    2437         The MAC address.  If a <link to="DHCPConfigScope::MachineNIC"/> config, this
     2437        The MAC address.  If a <link to="DHCPConfigScope_MachineNIC"/> config, this
    24382438        will be queried via the VM ID.
    24392439      </desc>
    … …  
    24422442    <attribute name="machineId" type="uuid" mod="string" readonly="yes">
    24432443      <desc>
    2444         The virtual machine ID if a <link to="DHCPConfigScope::MachineNIC"/> config,
    2445         null UUID for <link to="DHCPConfigScope::MAC"/>.
     2444        The virtual machine ID if a <link to="DHCPConfigScope_MachineNIC"/> config,
     2445        null UUID for <link to="DHCPConfigScope_MAC"/>.
    24462446      </desc>
    24472447    </attribute>
    24482448
    24492449    <attribute name="slot" type="unsigned long" readonly="yes">
    2450       <desc>The NIC slot number of the VM if a <link to="DHCPConfigScope::MachineNIC"/> config.</desc>
     2450      <desc>The NIC slot number of the VM if a <link to="DHCPConfigScope_MachineNIC"/> config.</desc>
    24512451    </attribute>
    24522452
    … …  
    1119111191    <attribute name="proxyURL" type="wstring" readonly="no">
    1119211192      <desc>
    11193         Proxy server URL for the <link to="ProxyMode::Manual" /> proxy mode.
     11193        Proxy server URL for the <link to="ProxyMode_Manual" /> proxy mode.
    1119411194
    1119511195        The format is: [{type}"://"][{userid}[@{password}]:]{server}[":"{port}]
    … …  
    1120211202        The port number defaults to 80 for http, 443 for https and 1080 for the socks ones.
    1120311203
    11204         <note>The password is currently stored as plain text!  Use the <link to="ProxyMode::System" />
     11204        <note>The password is currently stored as plain text!  Use the <link to="ProxyMode_System" />
    1120511205        mode if you consider the proxy password to be sensitive.</note>
    1120611206
    11207         An empty string will cause the behavior to be identical to <link to="ProxyMode::System" />.
     11207        An empty string will cause the behavior to be identical to <link to="ProxyMode_System" />.
    1120811208        For compatibility with libproxy, an URL starting with "direct://" will cause
    11209         <link to="ProxyMode::NoProxy" /> behavior.
     11209        <link to="ProxyMode_NoProxy" /> behavior.
    1121011210      </desc>
    1121111211    </attribute>
    … …  
    1553015530        </result>
    1553115531      </desc>
    15532       <param name="progressOther" type="IProgress" dir="in" />
     15532      <param name="progressOther" type="IProgress" dir="in">
     15533        <desc>Other progress object to be "cloned".</desc>
     15534      </param>
    1553315535      <param name="timeoutMS" type="unsigned long" dir="in">
    1553415536        <desc>Timeout (in ms). Pass 0 for an infinite timeout.</desc>
    … …  
    1850118503    </const>
    1850218504
    18503     <const name="VHWA" value="0x02">
     18505    <const name="VHWA" value="0x02" wsmap="suppress">
    1850418506      <desc>
    1850518507        Supports VHWA interface. If set, then
    … …  
    1850818510    </const>
    1850918511
    18510     <const name="VisibleRegion" value="0x04">
     18512    <const name="VisibleRegion" value="0x04" wsmap="suppress">
    1851118513      <desc>
    1851218514        Supports visible region. If set, then
    … …  
    1861518617        registered.
    1861618618      </desc>
    18617       <param name="x" type="unsigned long" dir="in"/>
    18618       <param name="y" type="unsigned long" dir="in"/>
    18619       <param name="width" type="unsigned long" dir="in"/>
    18620       <param name="height" type="unsigned long" dir="in"/>
     18619      <param name="x" type="unsigned long" dir="in">
     18620        <desc>X position of update.</desc>
     18621      </param>
     18622      <param name="y" type="unsigned long" dir="in">
     18623        <desc>Y position of update.</desc>
     18624      </param>
     18625      <param name="width" type="unsigned long" dir="in">
     18626        <desc>Width of update.</desc>
     18627      </param>
     18628      <param name="height" type="unsigned long" dir="in">
     18629        <desc>Height of update.</desc>
     18630      </param>
    1862118631    </method>
    1862218632
    … …  
    1862518635        Informs about an update and provides 32bpp bitmap.
    1862618636      </desc>
    18627       <param name="x" type="unsigned long" dir="in"/>
    18628       <param name="y" type="unsigned long" dir="in"/>
    18629       <param name="width" type="unsigned long" dir="in"/>
    18630       <param name="height" type="unsigned long" dir="in"/>
     18637      <param name="x" type="unsigned long" dir="in">
     18638        <desc>X position of update.</desc>
     18639      </param>
     18640      <param name="y" type="unsigned long" dir="in">
     18641        <desc>Y position of update.</desc>
     18642      </param>
     18643      <param name="width" type="unsigned long" dir="in">
     18644        <desc>Width of update.</desc>
     18645      </param>
     18646      <param name="height" type="unsigned long" dir="in">
     18647        <desc>Height of update.</desc>
     18648      </param>
    1863118649      <param name="image" type="octet" dir="in" safearray="yes">
    18632         <desc>
    18633           Array with 32BPP image data.
    18634         </desc>
     18650        <desc>Array with 32BPP image data.</desc>
    1863518651      </param>
    1863618652    </method>
    … …  
    2207322089
    2207422090      </desc>
    22075       <param name="name" type="wstring" dir="in"/>
    22076       <param name="value" type="wstring" dir="in"/>
    22077       <param name="flags" type="wstring" dir="in"/>
     22091      <param name="name" type="wstring" dir="in">
     22092        <desc>Name of guest property.</desc>
     22093      </param>
     22094      <param name="value" type="wstring" dir="in">
     22095        <desc>Value of guest property.</desc>
     22096      </param>
     22097      <param name="flags" type="wstring" dir="in">
     22098        <desc>Flags of guest property.</desc>
     22099      </param>
    2207822100      <param name="accessMode" type="unsigned long" dir="in">
    2207922101        <desc>0 = get, 1 = set, 2 = delete.</desc>
    2208022102      </param>
    22081       <param name="retValue" type="wstring" dir="out"/>
    22082       <param name="retTimestamp" type="long long" dir="out"/>
    22083       <param name="retFlags" type="wstring" dir="out"/>
     22103      <param name="retValue" type="wstring" dir="out">
     22104        <desc>When getting: Value of guest property.</desc>
     22105      </param>
     22106      <param name="retTimestamp" type="long long" dir="out">
     22107        <desc>When getting: Timestamp of guest property.</desc>
     22108      </param>
     22109      <param name="retFlags" type="wstring" dir="out">
     22110        <desc>When getting: Flags of guest property.</desc>
     22111      </param>
    2208422112    </method>
    2208522113
    … …  
    2666626694        Returns the list of the instances in the Cloud.
    2666726695      </desc>
    26668       <param name="machineState" type="CloudMachineState" dir="in" safearray="yes"/>
     26696      <param name="machineState" type="CloudMachineState" dir="in" safearray="yes">
     26697        <desc>State of each VM.</desc>
     26698      </param>
    2666926699      <param name="returnNames" type="IStringArray" dir="out">
    2667026700        <desc>VM names.</desc>
    … …  
    2668426714        Returns the list of the images in the Cloud.
    2668526715      </desc>
    26686       <param name="imageState" type="CloudImageState" dir="in" safearray="yes"/>
     26716      <param name="imageState" type="CloudImageState" dir="in" safearray="yes">
     26717        <desc>State of each image.</desc>
     26718      </param>
    2668726719      <param name="returnNames" type="IStringArray" dir="out">
    2668826720        <desc>Images names.</desc>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette