New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc comments for hal and lib. #118

Merged
merged 1 commit into from Jul 30, 2014

Conversation

Projects
None yet
4 participants
@bharrisau
Contributor

bharrisau commented Jul 29, 2014

Just leaves drivers (and platformtree) to go.

@bharrisau

This comment has been minimized.

Contributor

bharrisau commented Jul 29, 2014

cc #82

@@ -20,8 +20,7 @@ Some pins that could be configured here may be missing from actual MCU depending
on the package.
*/
use core::intrinsics::abort;
use core::option::{Option, Some, None};
use core::option::{Option};

This comment has been minimized.

@farcaller

farcaller Jul 29, 2014

Member

You can drop the { / } here.

pub enum WordLen {
WordLen8bits = 0,
WordLen9bits = 0b00010000,
}
impl WordLen {
/// Convert from number to WordLen

This comment has been minimized.

@farcaller

farcaller Jul 29, 2014

Member

I think it's "always use a trailing dot in the one-liner doc comment", no?

This comment has been minimized.

@bharrisau

bharrisau Jul 29, 2014

Contributor

It isn't currently (I had a quick check before I submitted). But I'll do a find/replace tonight.

@@ -117,6 +123,7 @@ impl UART {
}
#[no_split_stack]
#[allow(unused_variable)]

This comment has been minimized.

@farcaller

farcaller Jul 29, 2014

Member

Why not use _ for StopBit?

This comment has been minimized.

@errordeveloper

This comment has been minimized.

@bharrisau

bharrisau Jul 29, 2014

Contributor

Why not use _ for StopBit?

Because I was tired ;)

@farcaller

This comment has been minimized.

Member

farcaller commented Jul 29, 2014

Thanks for the cleanup work. I've added a few comments on that.

@bharrisau

This comment has been minimized.

Contributor

bharrisau commented Jul 30, 2014

r?

@bharrisau bharrisau removed the in progress label Jul 30, 2014

@bharrisau bharrisau referenced this pull request Jul 30, 2014

Closed

Set 'missing doc attribute' to deny for zinc.rs #82

0 of 6 tasks complete
#[inline(always)]
pub fn init_stack() {
set_stack_limit((&_eglobals as *const u32) as u32);
}
/// Helper function to copy over .data from rom to ram and zero out .bss
/// Helper function to initialize memory.
/// Copies .data sections in from RAM and initialized .bss sections to zero.

This comment has been minimized.

@farcaller

farcaller Jul 30, 2014

Member

initializes

This comment has been minimized.

@errordeveloper

errordeveloper Jul 30, 2014

Member

I'd quote those with backticks, i.e. .data and .bss...

@bharrisau

This comment has been minimized.

Contributor

bharrisau commented Jul 30, 2014

Not sure if you are still reviewing. But I made the changes to the bss/data stuff.

@farcaller

This comment has been minimized.

farcaller commented on aeeb8e8 Jul 30, 2014

r+

@hacknbot

This comment has been minimized.

Contributor

hacknbot commented on aeeb8e8 Jul 30, 2014

saw approval from farcaller
at bharrisau@aeeb8e8

This comment has been minimized.

Contributor

hacknbot replied Jul 30, 2014

merging bharrisau/zinc/doc2 = aeeb8e8 into auto

This comment has been minimized.

Contributor

hacknbot replied Jul 30, 2014

bharrisau/zinc/doc2 = aeeb8e8 merged ok, testing candidate = dd20f81

This comment has been minimized.

Contributor

hacknbot replied Jul 30, 2014

This comment has been minimized.

Contributor

hacknbot replied Jul 30, 2014

fast-forwarding master to auto = dd20f81

hacknbot added a commit that referenced this pull request Jul 30, 2014

Merge pull request #118 from bharrisau/doc2
Doc comments for hal and lib.

Reviewed-by: farcaller

@hacknbot hacknbot merged commit aeeb8e8 into hackndev:master Jul 30, 2014

2 checks passed

continuous-integration/travis-ci The Travis CI build passed
Details
default all tests passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment