#robotics | Logs for 2016-07-31

Back
[00:30:04] <z64555> the organizer modifies, or makes a seperate source file
[00:30:29] <z64555> it re-arranges the order of appears of all the declarations and definitions
[00:31:28] <z64555> A documentation program generates like an HTML page with information on the functions, etc., but does nothing to the source file
[00:32:17] <z64555> or it *might8 make a comment block above the function definition/declaration/etc. with the basic information, where you can fill in the rest of the intended functionality
[01:38:26] <anonnumberanon> That sounds like GNATdoc. I wonder if that works with C and C++ too.
[01:51:07] <anonnumberanon> Someone told me that the Eclipse IDE has a plugin for generating doc.
[05:05:29] <deshipu> generated docs are useless
[05:05:41] <veverak> why? :)
[05:06:04] <deshipu> because they add no information
[06:56:16] <LiohAu> hm any of you knows why my 4 encoders have 1 of the 2 channels that never goes to 5v ? :(
[06:56:48] <deshipu> let me get the crystal ball
[07:02:01] <LiohAu> deshipu: :'(
[08:10:38] <LiohAu> deshipu: any idea of what I could do to diagnoste what's happening?
[08:11:02] <veverak> deshipu: btw
[08:11:06] <LiohAu> it is like if I bought a single channel encoder :(
[08:11:06] <veverak> generated doc from code
[08:11:24] <veverak> should be only fancier and better way of reading code docstrings
[08:11:29] <veverak> +-
[08:21:02] <deshipu> better how?
[08:21:14] <deshipu> reading them in context sounds much better to me
[08:32:05] <veverak> deshipu: I refer to docstrings, not comments
[08:32:15] <veverak> aca the stuff that describes how API should be used
[08:32:54] <veverak> something with which you should not need to see the code
[10:45:55] <z64555> doxygen is what I've been using: http://www.stack.nl/~dimitri/doxygen/
[10:47:00] <deshipu> I like Sphinx
[10:47:11] <z64555> since I'm one of the maintainers of the codebase, the comments in the source code is what I generally go by
[10:47:13] <deshipu> but you still should write the comments by hand
[10:47:18] <deshipu> the documentation*
[10:47:26] <deshipu> and not "extract" it from code
[10:47:35] <z64555> well, with doxygen you *are* writing the documentation by hand
[10:47:40] <z64555> inside of the code
[10:47:49] <z64555> the tool just makes it look fancy
[10:48:25] <Snert_> I always prefer a lowest common demoninator format.
[10:48:26] <z64555> it features linked pages, modules, etc. which can be useful if you're stuck with an IDE that can't lookup a function
[10:49:48] <deshipu> as long as the content is created by humans, it's fine
[10:50:41] <z64555> codeblocks and notepad++ have plugins that can generate the boilerplate characters, essentailly slaps down a template or stencil for you to fill in
[10:51:02] <z64555> saves a bit of typing
[10:51:57] <veverak> lol
[10:51:59] <veverak> ;)
[10:52:15] <veverak> yeah, strip code, leave doc for sphing and (y)
[10:54:22] <z64555> ?
[11:00:02] <deshipu> z64555: that's just noise
[11:00:15] <z64555> k
[11:00:16] <deshipu> z64555: don't do all those frames and decorations
[11:01:01] <z64555> brief, details, param, returns, note, see, about the only commands I use
[11:01:37] <z64555> oh, and todo
[14:29:24] <rue_house> I'm just looking at my gas bill
[14:29:45] <rue_house> base charge $12.84
[14:29:59] <rue_house> delivery $5.64
[14:30:11] <rue_house> storage and transport 0.83
[14:30:27] <rue_house> COST OF GAS $1.03
[14:30:38] <rue_house> carbon tax $1.34
[14:30:51] <rue_house> clean energy levy $0.08
[14:31:03] <rue_house> Government sales tax $1.08
[14:31:34] <rue_house> so...
[14:31:48] <rue_house> gas is inefficient to get to someone as it is to use
[14:32:08] <SpeedEvil> Well, it's summer wherre you are, presumably
[14:32:21] <SpeedEvil> if there are fixed costs, it's going to be much worse than in winter
[14:37:14] <joga> well...it's also pretty costly to send a few grams to space
[14:39:45] <SpeedEvil> Depends.
[14:40:09] <SpeedEvil> I would really like to be able to launch ~10g satellites for $200 or so.