Dukascopy
 
 
Wiki JStore Search Login

JFOREX-3153 Documentation
 Post subject: JFOREX-3153 Documentation Post rating: 0   Post Posted: Wed 10 Aug, 2011, 14:30 
User avatar

User rating: 1
Joined: Wed 10 Aug, 2011, 13:58
Posts: 8
Location: ItalyItaly
Hi all.
I'm an experienced senior programmer that is beginning to evaluate translation of some my strategies in Jforex.
I'm interested to know if there is some hidden documentation file about Jforex API.
Because it's obvious that the exposed documentation level is about at sub draft level.
:)

One example, I was curious about method td_i of Interface IIndicators.
Searching with Google "td_i" and Jforex I find a link : https://code.google.com/p/jftoolbox/sour ... e.java?r=3
that use this method to generate a value for a DeMarker indicator for a mql bridge.
So I can suppose that method td_i return value for the DeMarker indicator.
A simple observation about the link of the guy that has written that bridge on Google code: where he has learned the use of the "td_i" method and all the others?
:)

But apart this Google "smart" system, there is some kind of credible documentation about JForex, or it's only an API collection for masochists Java programmers?
:)


 
 Post subject: Re: Documentation Post rating: 0   Post Posted: Thu 11 Aug, 2011, 09:26 
User avatar

User rating:
Joined: Fri 31 Aug, 2007, 09:17
Posts: 6139
positiveday wrote:
I'm interested to know if there is some hidden documentation file about Jforex API.
There are two major sources which serve as a documentation for JForex API:
JForex forum can be considered as an additional source of information. You can find indicators, strategies created by other users in Code Base. Also you can use forum Search or make a new post.
positiveday wrote:
One example, I was curious about method td_i of Interface IIndicators.
The algorithms for the indicators have been taken from various sources, a few of them are described in the wiki and for the rest the documentation is pending.


 
 Post subject: Re: Documentation Post rating: 0   Post Posted: Sat 13 Aug, 2011, 10:36 
User avatar

User rating: 1
Joined: Wed 10 Aug, 2011, 13:58
Posts: 8
Location: ItalyItaly
Many thanks for your reply.
Yes I know the two major source of information.
The Javadoc, that is generated by an automated procedure is almost void of comment, it shows only the present method with needed parameters.
The Wiki is the companion of the Javadoc, some little examples.
Seems that Dukascopy is not very interested to open his platform to automated trading.

My question about td_i indicator was not about how was written in the Jforex code in order to calculate that indicator.
I was asking me, how that guy that wrote the bridge has found (for example) that the td_i means the DeMarker indicator.
He has converted ALL Metatrader indicator and function, I must suppose he is a wizard with some crystal ball.
So I think that could be a programmer of API team, or that has get some other document.

At the end of this two week of conversion of a simple strategy in Jforex I think that I can go forward.
If the standard procedure must be that I've to ask on this forum all not documented question be prepared to a lot of posts from me.


 
 Post subject: Re: Documentation Post rating: 0   Post Posted: Mon 15 Aug, 2011, 11:07 
User avatar

User rating:
Joined: Fri 31 Aug, 2007, 09:17
Posts: 6139
positiveday wrote:
I was asking me, how that guy that wrote the bridge has found (for example) that the td_i means the DeMarker indicator.
He has converted ALL Metatrader indicator and function, I must suppose he is a wizard with some crystal ball.

Please elaborate what the bridge are you talking about.

Please tell us what should be described in more detail.


 
 Post subject: Re: Documentation Post rating: 1   Post Posted: Tue 16 Aug, 2011, 12:48 
User avatar

User rating: 1
Joined: Wed 10 Aug, 2011, 13:58
Posts: 8
Location: ItalyItaly
API Support wrote:
positiveday wrote:
I was asking me, how that guy that wrote the bridge has found (for example) that the td_i means the DeMarker indicator.
He has converted ALL Metatrader indicator and function, I must suppose he is a wizard with some crystal ball.

Please elaborate what the bridge are you talking about.

Please tell us what should be described in more detail.


The bridge is in the link I posted in first post :
https://code.google.com/p/jftoolbox/sour ... e.java?r=3

About what should be described with more detail I'm asking myself instead ... where are the details.
If I open javadoc I see the major number of methods without any description.
If, for example, I open Javadoc in class IIndicators, I see only a little number of indicators with two words about their meaning, for the other a programmer can imagine their function only if he can argue the function from the indicator name.
If you see the "ema" indicator, you can read a decent example of how should be documented all the Javadoc.

Another example.
I want to send an order.
There is the method
IOrder submitOrder(String label, Instrument instrument, OrderCommand orderCommand, double amount, double price, double slippage, double stopLossPrice, double takeProfitPrice) throws JFException;
About the label string in javadoc I read :
label - user defined identifier for the order. Label must be unique for the given user account among the current orders
Seems that the only requirement is that the "Label" must be unique for the given account etc. etc.
But when I send an order I receive an error message that talks about the maximum number of characters, talks about not permitted characters (what?) and that the Label cannot start with a number.
Why these informations are not present in documentation?
This about the "sendorder" that is one of the most documented method in Javadoc.

The fact is that it's not possible to write a big work like Jforex API and after don't spent the right time in order to do the required documentation.
This confines the use of Jforex programming to experienced programmers that accept to waste a lot of time in trials and errors in order to acquire a personal experience about an obscure programming API.
:)


 
 Post subject: Re: Documentation Post rating: 0   Post Posted: Tue 16 Aug, 2011, 12:58 
User avatar

User rating: 1
Joined: Wed 10 Aug, 2011, 13:58
Posts: 8
Location: ItalyItaly
Sorry if my words could seem rude, it's not my intention.
I've spent last 30 years of my life only in laboratories spending my time in electronic design and programming.
So, I'm used to write what I think, this sometimes is a defect but I cannot change ....
:)


 
 Post subject: Re: JFOREX-3153 Documentation Post rating: 0   Post Posted: Tue 16 Aug, 2011, 15:01 
User avatar

User rating:
Joined: Fri 31 Aug, 2007, 09:17
Posts: 6139
We appreciate your efforts in pinpointing shortcomings of the javadoc. Please keep us posted if you have some more ideas/questions.


 

Jump to:  

cron
  © 1998-2025 Dukascopy® Bank SA
On-line Currency forex trading with Swiss Forex Broker - ECN Forex Brokerage,
Managed Forex Accounts, introducing forex brokers, Currency Forex Data Feed and News
Currency Forex Trading Platform provided on-line by Dukascopy.com