Documenting the code itself

Collapse
This topic is closed.
X
X
Collapse
 
  • Page of 1
  • Time
  • Show
Clear All
new posts
Previous template Next
  • franky.backeljauw@ua.ac.be
    #1

    Documenting the code itself

    Hello,

    are there any (free) tools that can document not only the header and
    functions, but also the code within the functions? I am currently using
    doxygen, but I would like to be able to document the code within the
    functions, so that if I convert it to e.g. LaTeX, I get a print with
    source code intermixed with the actual algorithms and formulas used.

    Thanks for any reply.

    Regards,

    Franky Backeljauw.
    Tags: None
    • Peter van Merkerk
      #2
      Re: Documenting the code itself

      > are there any (free) tools that can document not only the header and[color=blue]
      > functions, but also the code within the functions? I am currently[/color]
      using[color=blue]
      > doxygen, but I would like to be able to document the code within the
      > functions, so that if I convert it to e.g. LaTeX, I get a print with
      > source code intermixed with the actual algorithms and formulas used.[/color]

      Doxygen can also be configured to include the source code in the
      documentation.

      --
      Peter van Merkerk
      peter.van.merke rk(at)dse.nl


        Comment

        • Attila Feher
          #3
          Re: Documenting the code itself

          Peter van Merkerk wrote:[color=blue][color=green]
          >> are there any (free) tools that can document not only the header and
          >> functions, but also the code within the functions? I am currently
          >> using doxygen, but I would like to be able to document the code
          >> within the functions, so that if I convert it to e.g. LaTeX, I get a
          >> print with source code intermixed with the actual algorithms and
          >> formulas used.[/color]
          >
          > Doxygen can also be configured to include the source code in the
          > documentation.[/color]

          Sure it can. But DoxyGen documents the interfaces while the OP wants to
          document the source code such as algorithms etc.

          --
          Attila aka WW


            Comment

            • Cedric LEMAIRE
              #4
              Re: Documenting the code itself

              franky.backelja uw@ua.ac.be wrote in message news:<Pine.LNX. 4.53.0309011108 510.13956@leibn iz.ruca.ua.ac.b e>...[color=blue]
              > are there any (free) tools that can document not only the header and
              > functions, but also the code within the functions?
              > I am currently using doxygen, but I would like to be able to document the
              > code within the functions, so that if I convert it to e.g. LaTeX, I get a
              > print with source code intermixed with the actual algorithms and formulas
              > used.[/color]
              If you just want to print the C++ source file, intersperced with LaTex
              explanations in your LaTeX document, I can provide you a free solution.
              Write your "LaTeX" documentation in remarkable C++ comments, something like
              /*{ ... LaTeX stuffs ... }*/
              and, if you are interested, I'll send you (or post it here, it isn't so long)
              a translation script written in CodeWorker (a LGPL scripting language for
              applying generative programming in the development process, available
              at "http://www.codeworker. org") that will translate your C++ source file to
              LaTeX.
              Better than that, in fact: you will have the capability to write something
              like:
              %##markup##"imp ort_C++_file:my C++file1.cpp"
              in your main LaTex document, and so, you will be able to integrate as many
              explained C++ files as you wish.

              Tell me if you are interested or if you want to test the result.

                Comment

                • franky.backeljauw@ua.ac.be
                  #5
                  Re: Documenting the code itself

                  On Mon, 1 Sep 2003, Cedric LEMAIRE wrote:
                  [color=blue]
                  > If you just want to print the C++ source file, intersperced with LaTex
                  > explanations in your LaTeX document, I can provide you a free solution.
                  > Write your "LaTeX" documentation in remarkable C++ comments, something like
                  > /*{ ... LaTeX stuffs ... }*/
                  > and, if you are interested, I'll send you (or post it here, it isn't so long)
                  > a translation script written in CodeWorker (a LGPL scripting language for
                  > applying generative programming in the development process, available
                  > at "http://www.codeworker. org") that will translate your C++ source file to
                  > LaTeX.
                  > [..]
                  > Tell me if you are interested or if you want to test the result.[/color]

                  Yes, I am interested indeed ... Could you sent me the script, and if
                  possible an example file, so I can see it immediately? I would appreciate
                  it very much.

                  Thanks in advance.

                  Regards,

                  Franky Backeljauw

                    Comment

                    • Cedric LEMAIRE
                      #6
                      Re: Documenting the code itself

                      franky.backelja uw@ua.ac.be wrote in message news:<Pine.LNX. 4.53.0309021457 470.13258@leibn iz.ruca.ua.ac.b e>...[color=blue]
                      > On Mon, 1 Sep 2003, Cedric LEMAIRE wrote:
                      >[color=green]
                      > > If you just want to print the C++ source file, intersperced with LaTex
                      > > explanations in your LaTeX document, I can provide you a free solution.
                      > > Write your "LaTeX" documentation in remarkable C++ comments, something like
                      > > /*{ ... LaTeX stuffs ... }*/
                      > > and, if you are interested, I'll send you (or post it here, it isn't so long)
                      > > a translation script written in CodeWorker (a LGPL scripting language for
                      > > applying generative programming in the development process, available
                      > > at "http://www.codeworker. org") that will translate your C++ source file to
                      > > LaTeX.
                      > > [..]
                      > > Tell me if you are interested or if you want to test the result.[/color]
                      >
                      > Yes, I am interested indeed ... Could you sent me the script, and if
                      > possible an example file, so I can see it immediately? I would appreciate
                      > it very much.[/color]
                      I'll send the script and an example to your personal email.

                        Comment

                        Previous template Next
                        Working...