Tagged Questions
8
votes
3answers
135 views
How to document experimental or incomplete APIs like @deprecated?
Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely ...
8
votes
4answers
564 views
How are undocumented functions discovered?
I've always wondered how do you find undocumented / private API ?
Example the Apple undocumented / private API, Play Station, Windows Phone 7, Win32 Kernel, Windows API, hidden callback, etc...
...
6
votes
2answers
305 views
Are there any C API explorers/browsers out there that include the GNU C Library methods and data structures?
I am looking for something similar to the Java API documentation, but for the GNU C Library.
I am trying to develop a simple server/client Sockets program but I keep getting lost in the different ...
6
votes
5answers
417 views
Learning about the Facebook Platform [closed]
I'm looking to learn more about the Facebook platform but I can't say I've found the IRC channel, the Facebook Developer Forum, or the online documentation very helpful.
Has anyone else recently been ...
5
votes
2answers
297 views
How to document requirements for an API systematically?
I am currently working on a project, where I have to analyze the requirements of two given IT systems, that use cloud computing, for a Cloud API. In other words, I have to analyze what requirements ...
3
votes
1answer
95 views
How to automate the API Diff document?
We can use doxygen to do the documentation, but how can I do the API Diff?
Any open source or free solution for that? Or I need manually prepare? Thanks.
2
votes
4answers
282 views
how to layout good documentation
I need to write out a documentation for developers to be able to use some API web software how should i lay out a documentation? What should always be included? And does it need to be really long or ...
2
votes
2answers
120 views
Questions to ask a 3rd party API provider [closed]
I'm due to meet with a developer/sales person from a new 3rd party resource we're about to start using. The main topic I'll be interested in, is their API as I will be the developer making use of it ...
2
votes
1answer
348 views
Open Source Web-based CMS for writing and managing API documentation
This is a question that have somewhat been asked before (i.e.: How to manage an open source project's documentation). However, my question is a little different because:
We're not developing open ...
1
vote
2answers
134 views
How to use the APIs for different platforms?
From what I know, learning a programming language consists of :
1- Learning the syntax
2- Learning how does the language handle\use\implement its "abilities" (Classes, delegates, structs, ...
0
votes
2answers
238 views
How do I read API documentation?
I've been trying to read through the RoR API to try to learn things that the tutorial missed, and I haven't been able to follow it at all. The only time I've read documentation was when I needed to ...
0
votes
1answer
143 views
on the dichotomy between internal and external documentation
For what kinds (size, complexity, scope, user-base, etc.) of APIs (or Applications) -- the separation between internal and external documentation is good (or necessary).
Internal -- that which is ...
