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

MySql variables and php -

-
I am getting an error with php in order to format mysql_query () in php to format this string What is the right way? SELECT SELECT SELECT (*) Agents @AgentCount; User_Agent_English, User_Angent_Oursal, US.___Gent_Aginal, COUNT (User_Agent_Percade) ACC, COUNT (*) / (AgentCount) Percentage by agents user_agent_preser order DEC limit limit 50; In PHP, how am i setting $ query $ query = "SELECT count (*) agents @ agentcount; SELECT user_agent_parsed, User_agent_original , COUNT (user_agent_parsed) ascount, COUNT (*) / (@AgentCount) as a percentage by user_agent_parced by URI date DESC limit 50 "; This exact query will work properly if I put it in MySQL directly through a command line session. Do I need to release two separate php calls from mysql_query () and store the results first? I get the following error: There is an error in your SQL syntax; Instead of using a sub-selection and instead of using the 'SELECT user_agent_parsed, user_agent_original, ne...
Read more

url rewriting - How to implement the returnurl like SO in PHP? -

-
This URL should work even after the rewrite. Is this possible? Otherwise, I can only hardcoded everything If you are trying to create a login system with redirection You need to use the HTTP_REFERER header to find out where the user came from so that you can send it back there. The best way to do this is to use something like this in your login form: // - Login php & Lt; Input type = "password" name = "password" /> & Lt; Input type = "hidden" name = "returnrelale" value = "& lt ;? php echo $ redirectURL ;? & gt;" / & Gt; & Lt; / Form & gt; Please note that some ISP, browser or proxy will delete the referrer header, so you can not rely on each user to work fully. If you use a statement, to check whether the header exists or not, you can send those users back to the homepage or whatever. Edit If you are looking to use $ _SERVER ['REQUEST_URI'], if you are running Apache It sho...
Read more

Which Python client library should I use for CouchdB? -

-
I am starting to experiment with CouchDB because it looks like we have the right solution to certain problems That all the work will be on a new project, which does not have any legacy dependency, which the client library will suggest you use, and why? If we overlap any of the OS. Freeband is available only in the collection of its ports, but asks to use the library's project website. None of those people are Ubuntu, which is only with ships, since those two OSAs are not common in libraries, I am probably installing something from source (and hopefully if I have time, then Ubuntu and FreeBSD People pack the package). For those interests, I want to use CouchDB as a convenient intermediate storage space for data passed between different services - think of a message bus system, but less formalities with. For example, we have daemons that download and pars the web page, then send an interesting bit to other daemons for further processing. Many of them are ill-defined until the...
Read more