Comments (12)
#76 would come along with this.
from sming.
Might sound simple stupid, but what about good old doxygen compatible comments per function or such?
That way it is easy to maintain in code directly but you still can generate some quite good documentation to read and search.
from sming.
I think it is a very good idea.
Sent from my iPhone
On May 19, 2015, at 2:02 PM, AlmightyFrog [email protected] wrote:
Might sound simple stupid, but what about good old doxygen compatible comments per function or such?
That way it is easy to maintain in code directly but you still can generate some quite good documentation to read and search.—
Reply to this email directly or view it on GitHub.
from sming.
+1
from sming.
I guess we should find a common agreement on which format to use.
Here you can see some example I tied out: AlmightyFrog@9c65f5f
Just install doxygen if not yet, go into Sming/ and enter "doxygen" to start generation. Afterwards you can open HTML from Sming/doc/
Not really happy with result, but maybe it helps some one else to come up with better suggestion.
One part where I'm really not sure is whether it's in a project like this better to comment in header or in source file.
from sming.
+1
from sming.
+1
from sming.
@AlmightyFrog Higly recommend to try NetBeans, it support Doxygen out of the box (as well as really nice code assistance)
from sming.
+1
from sming.
@AlmightyFrog I like your format. In fact this is a pure doxygen format.
If @anakod has no objections, let's continue in this direction.
I would like to ask for all core commits to contain doxygen documentation.
from sming.
Sorry to comment on a closed issue but I don't think this is fully resolved. The API is not fully documented and running doxygen against the Sming source does not give a particularly useful output. It would be advantageous to provide well documented API. (I have spent the past couple of weeks trying to understand Sming - it shouldn't be this difficult!) I would be happy to add some doxygen compatible docs to the source code (headers) but this needs to be coordinated so that we reduce duplicated or conflicting effort and use consistent documentation convention. Who is best placed to coordinate such a task (or empower someone to do so)?
It may also be advantageous to build the API documentation and host it online (within the wiki?) which may promote the project and facilitate developers.
Cheers Walt
from sming.
@riban-bw Someone needs to start doing this, and I feel like it should be you, @riban-bw. Since no one else was actually doing a thing in that direction - they will follow you, be a leader. Please, don't spend time on coordination that much, as you see in this ticket, it doesn't really help to make things happen. Lead by example, that's very simple and agile.
What you can do - go to gitter and tell everyone you are documenting a specific class/classes. That's it.
from sming.
Related Issues (20)
- Espressif SDK for Matter (only ESP32) HOT 1
- Unable to change Architecture or Soc once first make has been done HOT 1
- Manual approval required for workflow run 7275862152 HOT 2
- *** Preparation for Release 5.2.0 ***
- HttpServer how to broadcast or sendString to all clients. HOT 2
- The interactive tutorial for using host emulator is no longer available HOT 2
- HardwareTimer repeating when it shouldn't on Esp8266 HOT 3
- AdafruitGFX `fillscreen()`, `drawFastVLine()`, `drawFastHLine()` working only partially (ESP32) HOT 6
- maximum number of concurrent tcpConnections HOT 2
- On ESP32 GPIO32 GPIO33 can't be used as output HOT 5
- Kconfig.projbuild HOT 11
- vPortFree 517 line assert fail HOT 22
- Intellisense for esp-idf-5.2-beta1 HOT 2
- HttpUpgrader crashes when tested with Host emulator
- fatal error: mbedtls/mbedtls_config.h: No such file or directory for esp32/esp32c3 in IDF-4.4 HOT 5
- ESP32 IDF 4.3, 4.4 due for deprecation HOT 3
- error: implicit declaration of function 'system_rtc_mem_read' HOT 2
- LwIP seems to not correctly handle packages larger than MTU HOT 29
- `time_t` size is inconsistent
- HostTests stalling on esp8266 `Waiting for timer1 callback test to complete` HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sming.