VirtualBox

Changeset 65806 in vbox


Ignore:
Timestamp:
Feb 20, 2017 8:58:46 AM (8 years ago)
Author:
vboxsync
Message:

IEMAllInstructionsPython.py: Try make doxygen happy.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/VMM/VMMAll/IEMAllInstructionsPython.py

    r65805 r65806  
    4949# Annotation example:
    5050#
    51 # @opmnemonic  add
    52 # @op1         reg:Eb
    53 # @op2         rm:Gb
    54 # @opmaps      onebyte
    55 # @oppfx       none
    56 # @opcode      0x00
    57 # @openc       ModR/M
    58 # @opfltest    none
    59 # @opflmodify  of,sz,zf,af,pf,cf
    60 # @opflundef   none
    61 # @opflset     none
    62 # @opflclear   none
    63 # @ophints     harmless
    64 # @opstats     add_Eb_Gb
    65 # @opgroup     op_gen_arith_bin
    66 # @optest                  in1=1 in2=1 -> out1=2 outfl=a?,p?
    67 # @optest      oppfx:o32   in1=0xfffffffe:dw in2=1:dw -> out1=0xffffffff:dw outfl=a?,p?
     51# \@opmnemonic  add
     52# \@op1         reg:Eb
     53# \@op2         rm:Gb
     54# \@opmaps      onebyte
     55# \@oppfx       none
     56# \@opcode      0x00
     57# \@openc       ModR/M
     58# \@opfltest    none
     59# \@opflmodify  of,sz,zf,af,pf,cf
     60# \@opflundef   none
     61# \@opflset     none
     62# \@opflclear   none
     63# \@ophints     harmless
     64# \@opstats     add_Eb_Gb
     65# \@opgroup     op_gen_arith_bin
     66# \@optest                  in1=1 in2=1 -> out1=2 outfl=a?,p?
     67# \@optest      oppfx:o32   in1=0xfffffffe:dw in2=1:dw -> out1=0xffffffff:dw outfl=a?,p?
    6868
    6969
    … …  
    149149    ## CPU context fields.
    150150    kdFields = {
    151         'op1': [],  ## @op1
    152         'op2': [],  ## @op2
    153         'op3': [],  ## @op3
    154         'op4': [],  ## @op4
     151        'op1': [],  ## \@op1
     152        'op2': [],  ## \@op2
     153        'op3': [],  ## \@op3
     154        'op4': [],  ## \@op4
    155155
    156156        'efl': [],
    … …  
    283283    """
    284284
    285     ## @op[1-4]
     285    ## \@op[1-4]
    286286    kdLocations = {
    287287        'reg':  [], ## modrm.reg
    … …  
    289289    };
    290290
    291     ## @op[1-4]
     291    ## \@op[1-4]
    292292    kdTypes = {
    293293        'Eb':   [],
    … …  
    686686    def parseTagOpBrief(self, sTag, aasSections, iTagLine, iEndLine):
    687687        """
    688         Key:    @opbrief
     688        Tag:    \@opbrief
    689689        Value:  Text description, multiple sections, appended.
    690690
    … …  
    716716    def parseTagOpDesc(self, sTag, aasSections, iTagLine, iEndLine):
    717717        """
    718         Key:    @opdesc
     718        Tag:    \@opdesc
    719719        Value:  Text description, multiple sections, appended.
    720720
    … …  
    754754    def parseTagOpOperandN(self, sTag, aasSections, iTagLine, iEndLine):
    755755        """
    756         Tags:  @op1, @op2, @op3, @op4
     756        Tags:  \@op1, \@op2, \@op3, \@op4
    757757        Value: where:type
    758758
    … …  
    799799    def parseTagOpMaps(self, sTag, aasSections, iTagLine, iEndLine):
    800800        """
    801         Tag:    @opmaps
     801        Tag:    \@opmaps
    802802        Value:  map[,map2]
    803803
    … …  
    832832        return True;
    833833
    834     ## @oppfx values.
     834    ## \@oppfx values.
    835835    kdPrefixes = {
    836836        '0x66': [],
    … …  
    841841    def parseTagOpPfx(self, sTag, aasSections, iTagLine, iEndLine):
    842842        """
    843         Tag:        @oppfx
     843        Tag:        \@oppfx
    844844        Value:      none|0x66|0xf3|0xf2
    845845
    … …  
    875875        return True;
    876876
    877     ## Special @opcode tag values.
     877    ## Special \@opcode tag values.
    878878    kdSpecialOpcodes = {
    879879        '/reg':         [],
    … …  
    887887    def parseTagOpcode(self, sTag, aasSections, iTagLine, iEndLine):
    888888        """
    889         Tag:        @opcode
     889        Tag:        \@opcode
    890890        Value:      0x?? | /reg | mr/reg | 11 /reg | !11 /reg | 11 mr/reg | !11 mr/reg
    891891
    … …  
    909909        return True;
    910910
    911     ## Valid values for @openc
     911    ## Valid values for \@openc
    912912    kdEncodings = {
    913913        'ModR/M': [],
    … …  
    916916    def parseTagOpEnc(self, sTag, aasSections, iTagLine, iEndLine):
    917917        """
    918         Tag:        @openc
     918        Tag:        \@openc
    919919        Value:      ModR/M|TBD
    920920
    … …  
    939939        return True;
    940940
    941     ## EFlags values allowed in @opfltest, @opflmodify, @opflundef, @opflset, and @opflclear.
     941    ## EFlags values allowed in \@opfltest, \@opflmodify, \@opflundef, \@opflset, and \@opflclear.
    942942    kdEFlags = {
    943943        # Debugger flag notation:
    … …  
    996996
    997997    def parseTagOpEFlags(self, sTag, aasSections, iTagLine, iEndLine):
    998         """ @opfltest, @opflmodify, @opflundef, @opflset, @opflclear """
     998        """
     999        Tags:   \@opfltest, \@opflmodify, \@opflundef, \@opflset, \@opflclear
     1000        Value:  <eflags specifier>
     1001
     1002        """
    9991003        oInstr = self.ensureInstructionForOpTag(iTagLine);
    10001004
    … …  
    10231027        return True;
    10241028
    1025     ## @ophints values.
     1029    ## \@ophints values.
    10261030    kdHints = {
    10271031        'invalid':               'DISOPTYPE_INVALID',                ##<
    … …  
    10571061    def parseTagOpHints(self, sTag, aasSections, iTagLine, iEndLine):
    10581062        """
    1059         Tag:        @ophints
     1063        Tag:        \@ophints
    10601064        Value:      Comma or space separated list of flags and hints.
    10611065
    … …  
    10891093        return True;
    10901094
    1091     ## @opcpuid
     1095    ## \@opcpuid
    10921096    kdCpuIdFlags =  {
    10931097        'vme':      'X86_CPUID_FEATURE_EDX_VME',
    … …  
    11351139    def parseTagOpCpuId(self, sTag, aasSections, iTagLine, iEndLine):
    11361140        """
    1137         Tag:        @opcpuid
     1141        Tag:        \@opcpuid
    11381142        Value:      none | <CPUID flag specifier>
    11391143
    … …  
    11691173    def parseTagOpGroup(self, sTag, aasSections, iTagLine, iEndLine):
    11701174        """
    1171         Tag:        @opgroup
     1175        Tag:        \@opgroup
    11721176        Value:      op_grp1[_subgrp2[_subsubgrp3]]
    11731177
    … …  
    11931197        return True;
    11941198
    1195     ## @opunused, @opinvalid, @opinvlstyle
     1199    ## \@opunused, \@opinvalid, \@opinvlstyle
    11961200    kdInvalidStyles = {
    11971201        'immediate':                [], ##< CPU stops decoding immediately after the opcode.
    … …  
    12041208    def parseTagOpUnusedInvalid(self, sTag, aasSections, iTagLine, iEndLine):
    12051209        """
    1206         Tag:    @opunused, @opinvalid, @opinvlstyle
     1210        Tag:    \@opunused, \@opinvalid, \@opinvlstyle
    12071211        Value:  <invalid opcode behaviour style>
    12081212
    1209         The @opunused indicates the specification is for a currently unused
     1213        The \@opunused indicates the specification is for a currently unused
    12101214        instruction encoding.
    12111215
    1212         The @opinvalid indicates the specification is for an invalid currently
     1216        The \@opinvalid indicates the specification is for an invalid currently
    12131217        instruction encoding (like UD2).
    12141218
    1215         The @opinvlstyle just indicates how CPUs decode the instruction when
    1216         not supported (@opcpuid, @opmincpu) or disabled.
     1219        The \@opinvlstyle just indicates how CPUs decode the instruction when
     1220        not supported (\@opcpuid, \@opmincpu) or disabled.
    12171221        """
    12181222        oInstr = self.ensureInstructionForOpTag(iTagLine);
    … …  
    12501254    def parseTagOpTest(self, sTag, aasSections, iTagLine, iEndLine):
    12511255        """
    1252         Tag:        @optest
     1256        Tag:        \@optest
    12531257        Value:      [<selectors>[ ]?] <inputs> -> <outputs>
    12541258        Example:    mode==64bit ? in1=0xfffffffe:dw in2=1:dw -> out1=0xffffffff:dw outfl=a?,p?
    … …  
    13801384    def parseTagOpFunction(self, sTag, aasSections, iTagLine, iEndLine):
    13811385        """
    1382         Tag:        @opfunction
     1386        Tag:        \@opfunction
    13831387        Value:      <VMM function name>
    13841388
    … …  
    14081412    def parseTagOpStats(self, sTag, aasSections, iTagLine, iEndLine):
    14091413        """
    1410         Tag:        @opstats
     1414        Tag:        \@opstats
    14111415        Value:      <VMM statistics base name>
    14121416
    … …  
    14361440    def parseTagOpDone(self, sTag, aasSections, iTagLine, iEndLine):
    14371441        """
    1438         Tag:    @opdone
     1442        Tag:    \@opdone
    14391443        Value:  none
    14401444
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