You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/09/14 06:48:05 UTC

git commit: comment on the units for TSContScheduleEvery()

Updated Branches:
  refs/heads/master 4fab19a1a -> 93184bbfa


comment on the units for TSContScheduleEvery()


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/93184bbf
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/93184bbf
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/93184bbf

Branch: refs/heads/master
Commit: 93184bbfa20a3c3eab0aaee17da0343ed3743b9a
Parents: 4fab19a
Author: James Peach <jp...@apache.org>
Authored: Fri Sep 13 21:47:54 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Fri Sep 13 21:47:54 2013 -0700

----------------------------------------------------------------------
 proxy/api/ts/ts.h.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/93184bbf/proxy/api/ts/ts.h.in
----------------------------------------------------------------------
diff --git a/proxy/api/ts/ts.h.in b/proxy/api/ts/ts.h.in
index 286e499..ff025d5 100644
--- a/proxy/api/ts/ts.h.in
+++ b/proxy/api/ts/ts.h.in
@@ -2246,7 +2246,7 @@ extern "C"
   tsapi void TSContDataSet(TSCont contp, void* data);
   tsapi void* TSContDataGet(TSCont contp);
   tsapi TSAction TSContSchedule(TSCont contp, TSHRTime timeout, TSThreadPool tp);
-  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every, TSThreadPool tp);
+  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every /* millisecs */, TSThreadPool tp);
   tsapi TSAction TSHttpSchedule(TSCont contp, TSHttpTxn txnp, TSHRTime timeout);
   tsapi int TSContCall(TSCont contp, TSEvent event, void* edata);
   tsapi TSMutex TSContMutexGet(TSCont contp);


Re: git commit: comment on the units for TSContScheduleEvery()

Posted by Igor Galić <i....@brainsware.org>.

----- Original Message -----
> On Sep 13, 2013, at 10:48 PM, jpeach@apache.org wrote:
> 
> >   tsapi void TSContDataSet(TSCont contp, void* data);
> >   tsapi void* TSContDataGet(TSCont contp);
> >   tsapi TSAction TSContSchedule(TSCont contp, TSHRTime timeout,
> >   TSThreadPool tp);
> > -  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every,
> > TSThreadPool tp);
> > +  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every /*
> > millisecs */, TSThreadPool tp);
> >   
> 
> 
> Wouldn't it be better to put such comments in a Doxygen section above? We
> (sometimes ...) do that for the APIs in ts/ts.h.
> 
> Also, is the Sphinx docs correct for these APIs ?


Given that James is allergic to Doxygen.... ;)
 
> -- Leif
> 
> 

-- 
Igor Galić

Tel: +43 (0) 664 886 22 883
Mail: i.galic@brainsware.org
URL: http://brainsware.org/
GPG: 6880 4155 74BD FD7C B515  2EA5 4B1D 9E08 A097 C9AE

Re: git commit: comment on the units for TSContScheduleEvery()

Posted by Leif Hedstrom <zw...@apache.org>.
On Sep 13, 2013, at 10:48 PM, jpeach@apache.org wrote:

>   tsapi void TSContDataSet(TSCont contp, void* data);
>   tsapi void* TSContDataGet(TSCont contp);
>   tsapi TSAction TSContSchedule(TSCont contp, TSHRTime timeout, TSThreadPool tp);
> -  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every, TSThreadPool tp);
> +  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every /* millisecs */, TSThreadPool tp);
>   


Wouldn't it be better to put such comments in a Doxygen section above? We (sometimes ...) do that for the APIs in ts/ts.h.

Also, is the Sphinx docs correct for these APIs ? 

-- Leif


Re: git commit: comment on the units for TSContScheduleEvery()

Posted by Leif Hedstrom <zw...@apache.org>.
On Sep 13, 2013, at 10:48 PM, jpeach@apache.org wrote:

>   tsapi void TSContDataSet(TSCont contp, void* data);
>   tsapi void* TSContDataGet(TSCont contp);
>   tsapi TSAction TSContSchedule(TSCont contp, TSHRTime timeout, TSThreadPool tp);
> -  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every, TSThreadPool tp);
> +  tsapi TSAction TSContScheduleEvery(TSCont contp, TSHRTime every /* millisecs */, TSThreadPool tp);
>   


Wouldn't it be better to put such comments in a Doxygen section above? We (sometimes ...) do that for the APIs in ts/ts.h.

Also, is the Sphinx docs correct for these APIs ? 

-- Leif