LinuxQuestions.org
Visit Jeremy's Blog.
Home Forums Tutorials Articles Register
Go Back   LinuxQuestions.org > Forums > Non-*NIX Forums > Programming
User Name
Password
Programming This forum is for all programming questions.
The question does not have to be directly related to Linux and any language is fair game.

Notices


Reply
  Search this Thread
Old 11-01-2011, 08:21 AM   #1
pyqaz
LQ Newbie
 
Registered: Nov 2011
Posts: 1

Rep: Reputation: Disabled
Doxygen - Inline comments in Python


Hi,

I'm trying to generate the following Doxygen output for a Python script:


ordertype_TIF_tests::sell_mkt_day_multifillpartial Namespace Reference
(Sell; multiple partial fills) Market Day order More...
--------------------------------------------------------------------------------
Detailed Description
(Sell; multiple partial fills) Market Day order

Place a sell order for 20

Fill for quantity 8

Fill for quantity 7


I've been able to generate this with the code below.
I would like to keep the comments inline, so when someone looks at the code, the can understand what the statement below each comment does.


## @package ordertype_TIF_tests.sell_mkt_day_multifillpartial
# (Sell; multiple partial fills) Market Day order
from foundation import *
from notification import *
from order_management import *
from algo_helper import *
from position_management import *


def ClientExchange():

o = sendOrderSingle(Side = "2", sb = "DAB.L", oq = 20)

## @package ordertype_TIF_tests.sell_mkt_day_multifillpartial
# @details Place a sell order for 20
s = waitOrderSingle(oq = 20)

acceptOrderSingle(s)
waitNewAck(order = o)

## @package ordertype_TIF_tests.sell_mkt_day_multifillpartial
# @details Fill for quantity 8
sendTrade(s, 8, 142)

## @package ordertype_TIF_tests.sell_mkt_day_multifillpartial
# @details Fill for quantity 7
sendTrade(s, 7, 142)

waitOrderEvents(dict(tp = Trade, order = o, LastPx = 142, LastQty = 8), dict(tp = Trade, order = o, LastPx = 142, LastQty = 7))

stopPlay()


Is there a way to generate the same output without repeating the @package statement over and over?

Any advice would be much appreciated!

--pyqaz
 
  


Reply



Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off



Similar Threads
Thread Thread Starter Forum Replies Last Post
[SOLVED] Python ConfigParser not saving comments EricTRA Programming 3 06-17-2011 03:15 AM
Using doxygen with C source jason_m Programming 4 08-12-2010 02:02 AM
using doxygen tarinisunil Linux - Software 1 03-06-2008 03:31 PM
doxygen question kpachopoulos Linux - General 1 11-05-2005 06:11 PM
Anyone use DOxygen for Perl? Seventh Programming 0 02-01-2005 09:04 AM

LinuxQuestions.org > Forums > Non-*NIX Forums > Programming

All times are GMT -5. The time now is 04:06 PM.

Main Menu
Advertisement
My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
Open Source Consulting | Domain Registration