c++ - How can I include a subset of a .cpp file in a Doxygen comment? -

-

I am trying to write some Doxygen comment blocks, and I would like to include example snippets of code. Of course, I really want to compile the examples so that they are not stale.

My example is cpp (which is included in i.e.). Looks like this: 

  #include "stdafx.h" #include "../types_lib/Time_Limiter.h" #Include & lt; Vector & gt; Zero tl_demo () {// There must be a gate to control some rare resources that should not be more than 10 times the second time_limit rare (10); // Here is a bunch of requests std :: vector & lt; Int & gt; Rake (500); For (size_t i = 0; i

and my header file (which I'm running Doxygen) looks like this: 

 
 < / Code> / ** * \ ingroup types_lib * * \ class Time_Limiter * * Brief Thread Safe Gate is used to control a resource (like an Internet quote service), on how often you can call it * * \ DontInclude Time_Limiter_example.cpp * \ skipline zero * \ until the endcode * ** /

and I just start with "zero demo" to add stuff to doxygen. Finally you want to obtain the file (but // without Andkod).

I have tried experimenting with \ dontinclude and \ skip, \ skipline, and \ ', and I can not understand the true sincerity.

Edit: My .h file is also included, and now I have got almost the right recruitment. What exactly do I want to do, is there a way to use without tag, and get rid of the last // endcode line from example.cpp?

Edit to add second ARG to clip macro.

Here I have done what works for me. Most have been taken from the ERIC with the signal ....

My source file is Time_Limiter_example.cpp: 

  #include "stdafx.h" #include "../ Types_lib / Time_Limiter.h "#includes & lt; Vector & gt; Zero tl_demo () {// There must be a gate to control some rare resources that should not be more than 10 times the second time_limit rare (10); // Here is a bunch of requests std :: vector & lt; Int & gt; Rake (500); For (size_t i = 0; i

and I want to include it, but it does not include # Is on top

I have defined an ALIAS in my Doxyfile: 

  ALIASES + = clip {2} = "\ dontinclude \ 1 \ n \ skipline \ 2 \ n \ Android "

And in my header, my comment looks like this: 

  / ** * \ ingroup types_lib * * \ class Time_Limiter * * \ Brief Thread Safe Gate is used to control a resource (such as an Internet quote service) on which you can call. * * * Clip {Time_Limiter_example.cpp, tl_demo} ** /

And that does what I want, which includes just the fun catkin tl_demo () from the .cpp file.


Comments

Post a Comment

Popular posts from this blog

asp.net - Javascript/DOM Why is does my form not support submit()? -

-
This is my first time working with asp.net and javascript, so I do not know very good web resources, or Much about javascript debugging I have to find out that on line oFormObject.submit (); Microsoft JScript Runtime Error: Object does not support this property or method I am using the link to work as a button because I am terrible in aesthetics and I think That link will look more professional than a table of 50 buttons. I have read that this solution can cause problems with browsers due to pre-rendering of my links and many additional traffic and problems, but CSS gives me a button like a link, which has issues of alignment and difference seemed to. & lt ;! DOCTYPE HTML PUBLIC "- // W3C // DTD HTML 4.01 // N" "http://www.w3.org/TR/html4/strict.dtd"> & Lt; Html xmlns = "http://www.w3.org/1999/xhtml" & gt; & Lt; Head & gt; & Lt; Link rel = "stylesheet" type = "text / css" href = "defect differen
Read more

sockets - Delphi: TTcpServer, connection reset when reading -

-
I am trying to implement one for Delphi, but there are some problems with communication. Fitnesse will start my process, and give me a portmember as a command line argument. Then I should make a socket on the port number given to me, and fitness will connect to that port I am using a TCPCP server for the job: < Pre> TcpServer1.LocalPort: = ParamStr (ParamCount); TcpServer1 Active: = true; On OnEXEPT () -Event, I send the protocol version to use as specified in the protocol. Process TForm1.TcpServer1Accept (From: TOBject; ClientSocket: TCustomIpClient); Var s: ansistring; Start clientSocket. Syndrome ('slim - v 0.0', # 10); SetLength (S, 6); ClientSketts Receavebook (S, 6); End; When I call ReceiveBuf (), the process ends, and fitness throws an exception: java.net.SocketException: connection Reset I have seen what sent and received. It shows that my code sends the protocol version, fitness sends back a message, and when I try to get this message
Read more

javascript - Classic ASP "ExecuteGlobal" statement acting differently on two servers -

-
I have a strange problem that I really do not know. In addition to developing a new ASP.NET site, I have to support the old "classic ASP" site. It is written in VBScript with a batch of JavaScript functions. Many of the JavaScript functions include 'files' Everything is fine on our production system (which security is controlled by another group - this is a military installation) Debugging them once did not work I). However, I have a fix for a vague bug that needs to be fully tested and some functions do not run under the "local" copy of the website that runs on my PC. For the record, I am running IIS 5.1 on XP. The problem is that some Javascript functions are running "OK" on the production server, but when they use it as a server, they are not defined on my PC what is happening that last Programmer, for some reason, has decided to put some functions in a series of files, which according to the observations, imitate the "need_once
Read more