Ah, I thought you were talking about the "polling mode vs callback mode" thing. Yes, the API docs should mention in which context a function may or may not be called.
For example, functions that can be safely called in perform routines may be annotated with something like "\qualifier dspsafe".
Christof
Well, I don't mean documentation all internal mechanisms but, in this case, it might have been helpful to at least note *which* functions should or shouldn't be called in which situations. For instance, I note which libpd functions *not* call when DSP is running.
On Aug 23, 2023, at 5:30 PM, Christof Ressi <info@christofressi.com> wrote:
so it would pay to fill out the header.Yeah, all API functions in "m_pd.h" should really have minimal documentation (preferrably doxygen).
However, I'm not sure that "m_pd.h" is the place for documenting the inner workings of Pd... I think the official manual would be a more natural place, as it already serves this purpose.
Anyway, once these things are written down somewhere, we can just post a link whenever someone asks about them :)
Christof