github.com/dancsecs/gotomd@v0.0.0-20240310162206-65c4805cf510/example1/README.md.gtm (about)

     1  # Package example1
     2  
     3  This project is used by the Szerszam utility function to test its markdown
     4  update methods against an independent standalone project. All features
     5  will be tested against this file so it will be updated and changed often.
     6  
     7  The following will be replaced by the go package documentation
     8  
     9  <!--- gotomd::doc::./package -->
    10  
    11  Here we will add function documentation:
    12  
    13  <!--- gotomd::doc::./TimesTwo -->
    14  
    15  and another:
    16  
    17  <!--- gotomd::doc::./TimesThree -->
    18  
    19  and the defined interface:
    20  
    21  <!--- gotomd::doc::./InterfaceType -->
    22  
    23  and the defined structure:
    24  
    25  <!--- gotomd::doc::./StructureType -->
    26  
    27  and run a specific test
    28  
    29  <!--- gotomd::tst::./Test_PASS_Example1 -->
    30  
    31  or run all tests in a package:
    32  
    33  <!--- gotomd::tst::./package -->
    34  
    35  or include a file
    36  
    37  <!--- gotomd::file::./example1.go -->
    38  
    39  or a single declaration:
    40  
    41  <!--- gotomd::dcl::./TimesTwo -->
    42  
    43  or a multiple declarations:
    44  
    45  <!--- gotomd::dcl::./TimesTwo TimesThree -->
    46  
    47  or a single declaration on a single-line:
    48  
    49  <!--- gotomd::dcls::./TimesTwo -->
    50  
    51  or a multiple declarations on a single-line:
    52  
    53  <!--- gotomd::dcls::./TimesTwo TimesThree -->
    54  
    55  or a natural declaration:
    56  
    57  <!--- gotomd::dcln::./TimesTwo -->
    58  
    59  or a multiple natural declarations:
    60  
    61  <!--- gotomd::dcln::./TimesTwo TimesThree -->